Create subscription
Notify Corrily that one of your customers has started a subscription.
Custom payment gateway integrations only
You do not need to use this endpoint if you have granted Corrily automated access to your payment gateway’s subscription and charge events.
Body Params
The amount (price) of the subscription.
Users’s two-letter ISO3166 country code.
A 10-digit (seconds) UNIX timestamp indicating when the subscription was created. This timestamp should represent when the subscription was initialized, regardless of the status of the subscription during the initialization. It’s rare to need to update created after initially setting it.
The payment gateway that handled the subscription. Accepted values: stripe,
paypal, chargebee
A unique identifier for the subscription. This can be the ID that the payment gateway assigned to the subscription.
A product ID string or a payment gateway integration object. Product IDs are created by Corrily when you set up your Corrily account. Email support@corrily.com if you don’t know them. See the response of the calculate price endpoint for an example of the structure of integration objects.
The status of the subscription. Accepted values: pending, trialing,
active, canceled
A User ID.
A 10-digit (seconds) UNIX timestamp
indicating when the subscription will be canceled. In other words, the
customer will no longer have access to your service after this time. This
parameter should only be provided when status is set to canceled.
A 10-digit (seconds) unix timestamp indicating when customer expressed their
intent to cancel. This parameter should only be provided when status is set
to canceled.
A 10-digit (seconds) UNIX timestamp
indicating when the trial subscription ends. This parameter should only be
provided when status is set to trialing.
A 10-digit (seconds) UNIX timestamp
indicating when the trial subscription begins. This parameter should only be
provided when status is set to trialing.