Billing

Get a plan quote

Previews what subscribing to a plan would do, without changing anything: the amount due now, when the plan starts, the next charge and whether a card must be added at checkout first.

GET
/billing/plans/{id}/quote

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

idstringrequired

The plan's id, from the plans in Get billing.

Response

application/json

Success

plan_idstringrequired

The quoted plan's id.

due_now_usdnumberrequired

The amount charged now, in US dollars.

starts_atstring | nullrequired

When the plan would start, ISO 8601; null for at once.

next_charge_usdnumber | nullrequired

The next charge after that, in US dollars; null when none is scheduled.

next_charge_atstring | nullrequired

When the next charge happens, ISO 8601; null when none is scheduled.

checkoutbooleanrequired

True when a card must be added at checkout first; subscribing then returns a payment_url.