Docs
Cancel License
DELETE /licenses/{licenseId}
DELETE
/licenses/{licenseId}Ends access at the period end; no refund. The core license cancels the whole subscription (cancel_at_period_end, and the webhook writes Canceled). A pass is removed at period end through a subscription schedule and held Canceled with RemovalScheduled. Managed and invoiced licenses are refused with 400. Requires OrganizationAdmin and an Idempotency-Key header, which you reuse to retry the same cancel safely. The license id comes from Licenses_GetLicenses. Returns the outcome (Applied) and accessUntil. To undo it before the period ends, use Licenses_ResumeLicense.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| licenseId | uuid | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
| Idempotency-Key | string | Optional |
Response
| Field | Type | Description |
|---|---|---|
| outcome | string| null | |
| hostedInvoiceUrl | string| null | |
| accessUntil | date-time| null |