POST/organizations/{organizationId}/billing/stripe/cancel
Cancel the Stripe subscription
Operation organizations.billing.stripe.cancel
Description
Cancels the organization's Stripe subscription at the end of the paid period and returns when sync ends, or null when it was already cancelling. Only organization administrators may call it; 502 means Stripe could not be reached.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
organizationId | path | string | required
|
Responses
200 OK
application/jsonStripeCancelResponse
The result of cancelling a Stripe subscription at period end.
1 field
cancelAtnumberrequirednullableUnix time in seconds when sync ends, or null when the subscription was already cancelling.
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Internal Server Error |
|
| 502 | Bad Gateway |
|
| 503 | Service Unavailable |
|