Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Body

application/json

Why the organization is cancelling its paid plan. Both fields are optional.

reason
enum<string> | null

Why you are cancelling, if you want to say: too_expensive, missing_features, switched_service, unused, too_complex or other. It is passed to Stripe as cancellation feedback.

Available options:
too_expensive,
missing_features,
switched_service,
unused,
too_complex,
other
details
string | null

Anything else you want us to know, up to 500 characters. It is passed to Stripe with the reason. Leading and trailing spaces are removed.

Maximum string length: 500

Response

CancellationResource

data
CancellationResource · object
required

Whether the organization's paid plan renews or ends at the end of its paid period, and on which day it ends.