Skip to main content
POST
Cancel a customer's plan

Authorizations

Authorization
string
header
required

A Custral API key, created in Settings → Developers → Applications, sent as Authorization: Bearer sk_…. The X-Api-Key header is also accepted and takes precedence. Use a secret key (sk_…) from your server; a publishable key (pk_…) may hold only objects:read and usage:write. Never expose a secret key in a browser.

Path Parameters

customer
string
required

The customer: your app's own customer id (the customer key property chosen in Settings → Quotes and invoicing) or a record id. A deal's record id bills the customer it links to.

Body

application/json
reason
enum<string>

Recorded in Stripe.

Available options:
too_expensive,
missing_features,
switched_service,
unused,
other
comment
string
Maximum string length: 500

Response

200 - application/json

When the plan ends.

data
object
reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"