Billing

Change the plan

Changed on

Apply a plan upgrade or schedule a downgrade. Requires a user credential with billing:manage.

post/billing/plan-change

Request

  • Base URL: https://api.sazabi.com/v1
  • URL: https://api.sazabi.com/v1/billing/plan-change
  • Auth: none declared

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).

planSlugstring required
discountCodestring

A promotion code to apply to the upgrade's immediate charge and, when the coupon repeats, to later renewals.

Response

OK

billingSubscriptionChangeIdstring required
billingSubscriptionIdstring required
statusstring required
typestring required
effectiveAtstring date-time required
invoiceIdstring nullable required
creditDeficitAmountstring
creditDeficitChargeAmountstring
creditTopUpAmountstring
immediateChargeAmountstring
subscriptionChargeAmountstring
proratedCreditGrantAmountstring
discountAmountstring

Changes

  • 6c0272144642Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status