POST
/
v1
/
subscriptions
/
{id}
/
cancel

Headers

x-api-key
string
required

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
live,
sandbox
object
string
required

String representing the object’s type. Objects of the same type share the same value.

product
object
required

The product associated with the subscription.

customer
object
required

The customer who owns the subscription.

collection_method
string
required

The method used for collecting payments for the subscription.

status
enum<string>
required

The current status of the subscription.

Available options:
active,
canceled,
unpaid,
paused,
trialing
last_transaction_id
string

The ID of the last paid transaction.

last_transaction_date
string

The date of the last paid transaction.

next_transaction_date
string

The date when the next subscription transaction will be charged.

current_period_start_date
string

The start date of the current subscription period.

current_period_end_date
string

The end date of the current subscription period.

canceled_at
string

The date and time when the subscription was canceled, if applicable.

created_at
string
required

The date and time when the subscription was created.

updated_at
string
required

The date and time when the subscription was last updated.

Get Subscription