Skip to main content
PATCH
/
v1
/
cancellation_reasons
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/cancellation_reasons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cancellation_reason": {
    "name": "Not using it"
  }
}
'
{
  "id": "cf4a367b-4d8e-4c2b-a17a-3dc4fb01fbce",
  "object": "cancellation_reason",
  "archived": false,
  "archived_at": null,
  "comment_enabled": false,
  "comment_prompt": null,
  "coupon_enabled": false,
  "label": "Too expensive",
  "position": 0,
  "discarded_at": null,
  "created_at": 1767909676,
  "updated_at": 1767909676
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Body

application/json
​
cancellation_reason
object

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.