Cancel a subscription

POST /v1/admin/billing/subscriptions/{id}/cancel

• Operation ID: cancelBillingSubscription
• Tags: Billing subscriptions
• Base URL: http://localhost:8787

Cancels in Stripe, by default at period end. Cancelling immediately (atPeriodEnd: false) requires confirm: true. Audited; publishes a dashboard event. The local subscription row is updated by the Stripe webhook.

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission billing.write.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: billing.write

Parameters

Name	In	Type	Required	Description
id	path	string<uuid>	yes	-

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
atPeriodEnd	boolean	no	Default: true
confirm	boolean	no	Default: false

Responses

200

Subscription state from Stripe.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (BillingSubscriptionAction)

Field	Type	Required	Description
id	string<uuid>	yes	-
status	string	yes	-
cancelAtPeriodEnd	boolean	yes	-

Errors

400

Request validation failed. validation_failed: confirm must be true to cancel immediately.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody) | object (ErrorBody)

Field	Type	Required	Description
(variant 1).success	boolean	yes	One of: false
(variant 1).error	object	yes	-
(variant 1).error.name	string	yes	One of: "ZodError"
(variant 1).error.issues	object[]	yes	-
(variant 1).error.issues[].code	string	yes	-
(variant 1).error.issues[].path	(string | number)[]	yes	-
(variant 1).error.issues[].message	string	yes	-
(variant 2).error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
(variant 2).details	any	no	Optional structured context. For 403 it is { perm }.

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

Application error

{
  "error": "validation_failed"
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "billing.write"
  }
}

404

subscription: no such subscription.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "subscription"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/admin/billing/subscriptions/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/cancel' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"atPeriodEnd":true,"confirm":false}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/billing/subscriptions/3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90/cancel", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "atPeriodEnd": true,
    "confirm": false
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();