Billing

Schedule subscription cancellation

Schedule cancellation at the end of the paid billing cycle.

post/billing/subscription-cancellation

Request body

organizationIdstring

Organization to operate on. Auto-filled from CLI and SDK context when omitted. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Response

OK

effectiveAtstring date-time required
currentBalancestring required
servicePolicy'active_until_period_end' required
creditPolicy'dormant_until_resubscription' required
scheduledFinalChargestring nullable required
autoTopUpEnabledboolean required
calculatedAtstring date-time required
billingSubscriptionChangeIdstring required
alreadyScheduledboolean required

Changes

Changed in 1 of the 4 revisions of this API.3

    • added the required property / to the response with the status

      response-required-property-added

    • added the required property /// to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added