Update subscription

post

https://client.corrily.com/v1/subscriptions/{user_id}/{origin}/{origin_id}

Notify Corrily that a subscription has changed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
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.

Path Params

origin

string

required

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

origin_id

string

required

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

user_id

string

required

The User ID that you provided when you created the subscription.

Body Params

amount

float

The amount (price) of the subscription.

cancel_at

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.

canceled_at

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.

created

int32

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.

currency

string

The three-letter (ISO 4217) currency code.

status

string

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

trial_start

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.

trial_end

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.

Headers

X-Api-Key

string

required

Your organization's API key.

Response

🚧Custom payment gateway integrations only

200200

🚧
Custom payment gateway integrations only