Docs

Resume License

POST /licenses/{licenseId}/resume

POST/licenses/{licenseId}/resume

Undoes a cancel while the period is still open, and records a Resume consent row first, since resuming restarts a recurring charge. A canceling subscription gets cancel_at_period_end turned off (the webhook writes Active). A pass scheduled for removal has its schedule released and is set back to Active. Refused with 400 when the license is not canceling, the period has ended, it is managed or locked, consent is missing (disclosureVersion and the verbatim disclosedTerms are both required), or a second pass on the same subscription is also scheduled for removal. Requires OrganizationAdmin and an Idempotency-Key header, which you reuse to retry the same resume safely. Returns the outcome (Applied).

Path Parameters

FieldTypeRequiredDescription
licenseIduuidRequired

Headers

FieldTypeRequiredDescription
Idempotency-KeystringOptional

Request Body

FieldTypeRequiredDescription
consentResumeLicenseRequestConsentInfoOptional

ResumeLicenseRequestConsentInfo

FieldTypeDescription
disclosureVersionstring| null
disclosedTermsstring| null

Response

FieldTypeDescription
outcomestring| null
hostedInvoiceUrlstring| null
accessUntildate-time| null