Skip to main content
Preview a credit purchase and its tax

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Body

application/json
amount_minor
integer
required

Top-up principal in whole US cents.

Required range: x >= 1

Response

Current purchase and tax quote.

amount
integer
required

Tax-exclusive credit amount in US cents; this is what is added to the balance.

Required range: x >= 1
tax
integer
required

Estimated tax in US cents, on the credits and the fee.

Required range: x >= 0
total
integer
required

Estimated total to charge in US cents: amount plus fee_minor plus tax.

Required range: x >= 1
address_required
boolean
required
fee_minor
integer

BoxRouter's purchase fee in US cents, computed by the server and charged on top of amount. Tax applies to amount plus fee. Absent on older services.

Required range: x >= 0
missing
string[]

Required billing address fields missing for an exact tax quote.