Skip to main content
GET
/
v1
/
cancellation_acts
List
curl --request GET \
  --url https://{defaultHost}/v1/cancellation_acts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/cancellation_acts"
  },
  "data": [
    {
      "id": "e9a19526-30fa-4cc0-a403-f7c50eb2b30d",
      "object": "cancellation_act",
      "comment": null,
      "coupon_applied": false,
      "preserved": false,
      "performed_at": 1769674928,
      "cancellation_reason": "1070e94a-8aeb-4320-8b98-73064b7bec94",
      "subscription": "85d6a504-2f6d-498f-931d-9c64c57be7f7",
      "created_at": 1769674928,
      "updated_at": 1769674928
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.