billing

Quote a plan change before submitting it

Returns Dodo's own quote for switching to tier. Every plan change is effective immediately: an upgrade charges the prorated difference on Dodo's hosted payment page, a downgrade charges nothing and leaves the unused value as credit toward future renewals. This is what the confirmation dialog shows before the customer commits to anything.

post/api/v1/billing/plan-change/preview

Request

  • Base URL: https://api.cadencz.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.cadencz.com/api/v1/billing/plan-change/preview
  • Auth: HTTP bearer

Request body

tierstring required
billing_period'monthly' | 'yearly'

Response

Successful Response

tierstring required
tier_namestring required
billing_period'monthly' | 'yearly' required
effective_at'immediately' | 'next_billing_date' required
charges_todayboolean required
immediate_total_minorinteger required
currencystring required
tax_minorinteger required
customer_credits_minorinteger required
recurring_pre_tax_minorinteger nullable required
recurring_currencystring nullable required
next_billing_datestring nullable required
needs_resumeboolean
resumes_current_planboolean
needs_fresh_checkoutboolean
needs_payment_fixboolean

Example response

{
  "billing_period": "monthly",
  "charges_today": true,
  "currency": "USD",
  "customer_credits_minor": 0,
  "effective_at": "immediately",
  "immediate_total_minor": 1320,
  "next_billing_date": "2026-09-23T10:30:00Z",
  "recurring_currency": "USD",
  "recurring_pre_tax_minor": 3900,
  "tax_minor": 0,
  "tier": "founder",
  "tier_name": "Founder"
}

Changes

No recorded changes to this operation across all 1 revision of this API.