Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

archived
boolean

Whether or not this cancellation reason is archived.

comment_enabled
boolean

Whether or not this cancellation reason should prompt the user for a comment.

comment_prompt
string | null

A breif customer-facing prompt for more detail that will be shown when this cancellation reason is selected.

coupon_enabled
boolean

Whether or not this cancellation reason should offer the subscription_protocol.cancellation_prevention_coupon to the customer to preserve the subscription.

label
string

The customer-facing label for this cancellation reason.

position
integer | null

The ordering position of this cancellation reason when displayed to customers.

archived_at
integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

discarded_at
integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.