Organization Billing

Cancel Subscription

Changed on

Cancel the current subscription.

Default: cancel at end of billing period (the subscription remains active until then, after which the organization downgrades). With immediate=true: cancel NOW — the org-deletion cascade and teardown callers need a cancel that actually ends billing today instead of leaving a live sub on the card.

post/v1/organizations/billing/subscription/cancel

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/billing/subscription/cancel
  • Auth: HTTP bearer

Request body

immediateboolean

Cancel NOW (Stripe Subscription.cancel) instead of at period end. Default False preserves the period-end behavior.

invoice_nowboolean

With immediate=true: generate a final proration invoice.

Response

Successful Response

subscription_idstring required
cancel_at_period_endboolean
statusstring nullable
messagestring

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API