Corrily home pagelight logo
  1. Subscriptions
  2. Update subscription
POST

/v1/subscriptions/{user_id}/{origin}/{origin_id}

X-Api-Key*

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

originRequired
string

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

origin_idRequired
string

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

user_idRequired
string

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

​
Body Params

amount
float

The amount (price) of the subscription.

cancel_at
integer

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.

canceled_at
integer

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
integer

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
integer

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
integer

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

{
  "message": "[dev=False] subscription record was written.",
  "success": true,
  "record": {
    "origin": "stripe",
    "type": "subscription",
    "latest_event_timestamp": 1628609045,
    "latest_event_id": "corrily_evt_1628609045",
    "corrily_product_id": 122,
    "org_id": 97,
    "origin_id": "o123",
    "user_id": "u123",
    "created": null,
    "interval": "month",
    "interval_count": 1,
    "status": "active",
    "cancel_at": null,
    "canceled_at": null,
    "trial_start": null,
    "trial_end": null,
    "currency": null,
    "amount": null,
    "amount_usd": null,
    "amount_usd_monthly": null
  }
}

curl --request POST \
     --url https://client.corrily.com/v1/subscriptions/user_id/origin/origin_id \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "amount": 0,
     "cancel_at": 0,
     "canceled_at": 0,
     "created": 0,
     "currency": "string",
     "status": "string",
     "trial_start": 0,
     "trial_end": 0
}
'