Skip to main content
GET
/
v1
/
cancellation_reasons
List
curl --request GET \
  --url https://{defaultHost}/v1/cancellation_reasons \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/cancellation_reasons"
  },
  "data": [
    {
      "id": "a144fa68-9093-43ef-996d-d312ceeb2384",
      "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.

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.

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.