Skip to main content
POST
Cancel Subscription

Authorizations

Authorization
string
header
required

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

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

subscriptionId
string
required

Query Parameters

environment
string

Environment slug. Defaults to "production"; unknown environment slugs return 404.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
atPeriodEnd
boolean
required

Response

Updated subscription.

id
string<uuid>
required
customerId
string<uuid> | null
required
priceId
string<uuid> | null
required
status
enum<string>
required
Available options:
incomplete,
trialing,
active,
past_due,
canceled,
unpaid
cancelAtPeriodEnd
boolean
required
currentPeriodEnd
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required