Skip to main content
GET
Read one offering's price and whether your brand can sell it

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Client-Id
string
required

the resolved account, set by the gateway.

Minimum string length: 1
X-Client-Brand-Ids
string
required

the brands the resolved account owns, set by the gateway.

Minimum string length: 1
X-Client-Key-Class
enum<string>

which kind of key was presented, set by the gateway.

Available options:
publishable,
secret

Path Parameters

brand_id
string
required

the brand to read. Must be one of your own brands; any other brand is not found (404, never 403 — existence is never revealed across accounts).

Query Parameters

offering_ref
string
required

the offering to price. Required.

Minimum string length: 1

Response

the offering's price and the brand's readiness to sell it

data
object
required

One offering's price and the brand's readiness to sell it. Read price_status inside pricing before the amount, and read readiness before you render a buy control — a price that resolves on a brand that is not ready to sell is a purchase the checkout will refuse.