MImicrosandbox
billing

Change the billing plan

Changed on
put/v1/orgs/{slug}/billing/plan

Request

  • Base URL
    https://api.microsandbox.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://api.microsandbox.dev/v1/orgs/{slug}/billing/plan
  • Auth
    HTTP bearer

Path parameters

slugstring required

Organization slug

Request body

planstring required

Catalog name of the plan to switch to (e.g. "builder").

Response

Plan changed

available_credit_centsinteger nullable

Positive USD credit Stripe will apply automatically to future invoices.

checkout_urlstring nullable

Hosted-checkout URL to complete payment for a just-changed plan (Autumn). Set only on a plan change that needs payment; the client redirects to it.

current_period_ends_atstring date-time nullable
effective_state'free' | 'active' | 'past_due' | 'suspended' required

Effective billing state derived from plan, period end, and suspension.

is_suspendedboolean required

Changes

  • b61270559d5eRevision changes
    • info

      added the optional property / to the response with the status

  • 90291f62c817Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the 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

    • info

      added the required property / to the response with the status