Send Subscription Status
POST/subscriptions/:id/status
Sends subscription status information to the customer through their preferred communication channel.
This API can only be used for subscriptions with the following statuses:
- Active
- Trialing
- Past due
Delivery channels are automatically selected based on available customer information:
- If customer email is available: Status is sent via email
- If customer phone is available: Status is sent via WhatsApp
- If WhatsApp delivery fails: Status is sent via SMS as a fallback
The status notification includes subscription details such as current status, upcoming payments, and recent changes. If no customer contact information is provided, the system will use the details stored in the subscription record.
Email notifications include contextual action links based on subscription status:
- For past due subscriptions: A link to reactivate the subscription
- For active and trialing subscriptions: A link to update the payment method
You can specify the customer's email or phone number, the preferred communication channel (email or SMS), and the language for the message.
Request
Responses
- 200
- 400
- 401
- 404
- 422
- 500
- 503
A subscription object
The request is incorrect or could not be processed
Unauthorized error. Please check your auth credentials
The specified resource was not found
The request was well-formed but could not be processed due to semantic errors
Unexpected server error
The service is temporarily unavailable