Skip to main content
GET
/
v1
/
cancellation_acts
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/cancellation_acts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "57513067-4502-4b92-9945-86d736a8c804",
  "object": "cancellation_act",
  "comment": null,
  "coupon_applied": false,
  "preserved": false,
  "performed_at": 1767909675,
  "cancellation_reason": "21ecd57f-1ae1-4daa-9e19-3112f826f3a9",
  "subscription": "36f13823-7ea3-41ef-b289-364f52af7bbd",
  "created_at": 1767909675,
  "updated_at": 1767909675
}

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.

​
comment
string | null

The comment left by the customer when they canceled the subscription.

​
coupon_applied
boolean

Whether or not the preservation coupon was applied to the subscription when it was preserved.

​
performed_at
integer

Time at which the cancellation act was performed. Measured in seconds since the Unix epoch.

​
preserved
boolean

Whether or not this subscription was preserved when the customer went to cancel it.

​
cancellation_reason

Expandable – The associated cancellation reason ID.

​
subscription

Expandable – The associated subscription ID.

​
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.