Skip to main content
GET
Retrieve Payment Quote

Authorizations

Authorization
string
header
required

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-06-2"

Path Parameters

id
string
required

The payment quote ID, prefixed pq_.

Response

payment quote retrieved

account_id
string
required

The account the purchase is priced for, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

address
object | null
required

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.

base_currency
string
required

Three-letter ISO 4217 code of the variants' own currency, lowercase. Equal to currency when nothing was converted.

Example:

"usd"

base_total
object
required

total in base_currency at exchange_rate: the variants' own prices after the promo code, plus tax_amount converted at exchange_rate when tax is added on top. Equal to total when nothing was converted. The payment charges total, in currency.

created_at
string
required

When the quote was priced, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

currency
string
required

Three-letter ISO 4217 currency code the purchase is priced and charged in, lowercase: the variants' own currency, or the presentment_currency it was converted into.

Example:

"usd"

discount
object
required

What the promo code takes off. Zero without a code.

exchange_rate
string | null
required

How many units of currency one unit of base_currency buys, as a decimal string such as "5.4321": the rate the variants' prices were converted at, fixed until expires_at, and the rate a payment consuming the quote is charged at. A string, like money amounts, so no float rounds it in transit. Null when nothing was converted.

Example:

"0.918"

expires_at
string
required

When the quote stops being chargeable, as an ISO 8601 timestamp. Quote again after it.

Example:

"2026-01-01T12:00:00.000Z"

id
string
required

Payment quote ID, prefixed pq_.

Example:

"pq_xxxxxxxxxxxxxx"

line_items
object[]
required
located_by
enum<string> | null
required

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 a preview: a payment cannot use it, so quote again with the buyer's address to pay. 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.

Available options:
shipping_address,
address,
ip_address,
null
Example:

"address"

payment_id
string | null
required

The payment holding this quote, prefixed pay_, or null while it is unspent. A declined payment keeps its quote and can be retried; check that payment's status.

Example:

"pay_xxxxxxxxxxxxxx"

promo_code_id
string | null
required

The promo code the quote applied, prefixed promo_, or null.

Example:

null

Lowercase ISO 4217 codes to offer the buyer in a currency picker, most relevant first: the currency of the country the buyer's ip_address is in, when this purchase can be converted into it and a payment method can collect it, then base_currency. Quote again with one as presentment_currency to price in it. Only base_currency when the quote was priced without presentment_currency.

shipping_address
object | null
required

The shipping address the purchase was priced with, or null. When present it is where tax was calculated.

subtotal
object
required

The price of every line before the promo code, tax and fees.

tax_amount
object
required

The tax a payment consuming this quote charges. Zero unless tax_status is calculated.

tax_behavior
enum<string> | null
required

Whether tax is added on top of the price (exclusive) or already inside it (inclusive). Null when no tax was calculated.

Available options:
inclusive,
exclusive,
null
Example:

"exclusive"

tax_ids
object[]
required
tax_status
enum<string>
required

calculated: every line was priced and a payment may consume the quote. not_applicable: this seller collects no tax on this purchase, so the quote owes none and may still be consumed. unavailable: tax could not be priced — the provider did not answer, or this seller's tax setup cannot price a purchase here — so a payment refuses the quote; quote again, or charge without quote_id to have tax calculated at charge time.

Available options:
calculated,
not_applicable,
unavailable
Example:

"calculated"

total
object
required

What the buyer pays: the subtotal less the discount, plus tax_amount when tax is added on top.