Skip to main content
POST
Preview studio offer margin

Authorizations

Authorization
string
header
required

Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.

Headers

X-BatchRelay-Client-Surface
string

Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Client-Version
string

Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100
X-BatchRelay-Invocation-Mode
string

Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.

Required string length: 1 - 100

Path Parameters

studio_id
string
required

Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.

Required string length: 5 - 256
Pattern: ^stu_[A-Za-z0-9_-]+$
offer_id
string
required

Body

application/json
sellable
object
required
event_id
string
recipient
object

Response

Offer margin preview

cost_status
enum<string>
required
Available options:
verified,
unknown,
incomplete,
stale
currency
string
required
Allowed value: "USD"
generated_at
string<date-time>
required
lines
object[]
required
normal_subtotal_cents
integer
required
Required range: x >= 0
offer_id
string
required
revision
integer
required
contribution_cents
integer
contribution_percent
number<double>
discount_cents
integer

Omitted when any line promotion price is unknown.

Required range: x >= 0
exclusions
string[]
promo_subtotal_cents
integer

Omitted when any line promotion price is unknown.

Required range: x >= 0