Skip to content
Start here

Cancel Reason

Create Cancel Reason
client.accounts.subscriptions.cancelReason.create(stringsubscriptionIdentifier, CancelReasonCreateParams { account_id, other, reason_code } params, RequestOptionsoptions?): CancelReasonCreateResponse { id, other, reason_code, 2 more }
POST/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
Get Cancel Reason
client.accounts.subscriptions.cancelReason.get(stringsubscriptionIdentifier, CancelReasonGetParams { account_id } params, RequestOptionsoptions?): CancelReasonGetResponse { id, other, reason_code, 2 more }
GET/accounts/{account_id}/subscriptions/{subscription_identifier}/cancel-reason
ModelsExpand Collapse
CancelReasonCreateResponse { id, other, reason_code, 2 more }
id?: string

The cancel reason identifier.

other?: string

Additional cancellation details.

reason_code?: Array<string>

The cancellation reason codes.

submitted?: string

When the cancel reason was submitted.

formatdate-time
subscription_id?: string

The subscription identifier.

CancelReasonGetResponse { id, other, reason_code, 2 more }
id?: string

The cancel reason identifier.

other?: string

Additional cancellation details.

reason_code?: Array<string>

The cancellation reason codes.

submitted?: string

When the cancel reason was submitted.

formatdate-time
subscription_id?: string

The subscription identifier.