Retrieve Payment Quote
Retrieves a payment quote, including when it expires.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-09-29"
Path Parameters
The payment quote ID, prefixed pq_.
Response
payment quote retrieved
The account the purchase is priced for, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
The billing address the purchase was priced with, or null. Where tax was calculated when no shipping address was given, and the address the registration belongs to.
When the quote was priced, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
ISO currency the purchase is priced and charged in, lowercase — the variants' own currency.
"usd"
What the promo code takes off. Zero without a code.
When the quote stops being chargeable, as an ISO 8601 timestamp. Quote again after it.
"2026-01-01T12:00:00.000Z"
Payment quote ID, prefixed pq_.
"pq_xxxxxxxxxxxxxx"
Which location tax was calculated for: shipping_address when it carries a country, else the billing address when it does, else the buyer's ip_address. A quote located by ip_address is an estimate: quote again with the buyer's address. Null when nothing in the request located the buyer, which only a seller that collects no tax on this purchase is quoted without; tax_status is then not_applicable.
shipping_address, address, ip_address, null "address"
The promo code the quote applied, prefixed promo_, or null.
null
The shipping address the purchase was priced with, or null. When present it is where tax was calculated.
The price of every line before the promo code, tax and fees.
The tax owed on the purchase. Zero unless tax_status is calculated.
Whether tax is added on top of the price (exclusive) or already inside it (inclusive). Null when no tax was calculated.
inclusive, exclusive, null "exclusive"
calculated: every line was priced. not_applicable: this seller collects no tax on this purchase, so the quote owes none. unavailable: tax could not be priced — the provider did not answer, or this seller's tax setup cannot price a purchase here; quote again.
calculated, not_applicable, unavailable "calculated"
What the buyer pays: the subtotal less the discount, plus tax_amount when tax is added on top.

