Sign in
Billing

Preview a plan change

Preview the cost and effect of changing to a plan without applying it. Requires a user credential with billing:manage.

post/billing/plan-change/preview

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

Response

OK

calculatedAtstring date-time required
type'upgrade' | 'downgrade' required
effectiveAtstring date-time required
currencystring required
currentPlanSlugstring required
targetPlanSlugstring required
currentPlanNamestring required
targetPlanNamestring required
currentPlanPricestring required
targetPlanPricestring required
currentCycleCreditsstring required
currentTargetCreditBalancestring required
cycleCreditsstring required

Credits added to the balance each paid cycle (billing_plans.config.cycleCredits). Additive, never a balance target.

targetCreditBalancestring required
creditDeficitAmountstring required
creditDeficitChargeAmountstring required
additionalCreditPricestring required
immediateChargeAmountstring required
subscriptionChargeAmountstring required
proratedCreditGrantAmountstring required
remainingCycleFractionstring required
nextCycleChargeAmountstring required

Changes

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

  • f7ae8f7754562See the full diff
    • ○

      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