API Reference

Create subscription

post
https://client.corrily.com/v1/subscriptions

Notify Corrily that one of your customers has started a subscription.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

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
float
required

The amount (price) of the subscription.

string

Users's two-letter ISO3166 country code.

int32
required

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.

string
required

The three-letter (ISO 4217) currency code.

string
required

The payment gateway that handled the subscription. Accepted values: stripe, paypal, chargebee

string
required

A unique identifier for the subscription. This can be the ID that the payment gateway assigned to the subscription.

string
required

A product ID string or a payment gateway integration object. Product IDs are created by Corrily when you set up your Corrily account. Email [email protected] if you don't know them. See the response of the calculate price endpoint for an example of the structure of integration objects.

string
required

The status of the subscription. Accepted values: pending, trialing, active, canceled

string
required

A User ID.

int32

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.

int32

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.

int32

A 10-digit (seconds) UNIX timestamp indicating when the trial subscription ends. This parameter should only be provided when status is set to trialing.

int32

A 10-digit (seconds) UNIX timestamp indicating when the trial subscription begins. This parameter should only be provided when status is set to trialing.

Headers
string
required

Your organization's API key.

Response

Updated about 5 years ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 years ago

Did this page help you?