Create Subscription
POST/subscriptions
Creates a new subscription with the specified parameters.
Subscription Lifecycle:
- When first created, the subscription has a
PENDING
status - To initiate billing, you must call the activate endpoint with payment details
- Once activated, the subscription will automatically bill according to the configured interval
Key Configuration Parameters:
- Billing settings: Amount, currency, interval (daily, weekly, monthly, yearly)
- Schedule customization: Interval count, trial period duration
- Customer information: Contact details, billing and shipping addresses
- Communication: Callback URLs for webhook notifications about subscription events
Best Practices:
- Set clear, descriptive names for subscriptions to help with identification
- Configure appropriate webhook notifications to monitor subscription status changes
- Consider offering trial periods to increase customer conversion rates
- Use metadata to store additional information relevant to your business logic
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