Skip to main content
PATCH
Revise, activate, pause, or archive a Commerce offer

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. Interactive MCP clients use registered OAuth applications, Authorization Code + PKCE, audience-bound tokens, and explicit workspace grants. Personal Sanctum tokens remain supported.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required
offer
string<uuid>
required

Body

application/json
type
enum<string>
Available options:
contribution,
fixed
status
enum<string>
Available options:
draft,
active,
paused,
archived
name
string
Maximum string length: 255
description
string | null
Maximum string length: 5000
currency
enum<string>
Available options:
usd
unit_amount_minor
integer | null

Required for fixed-price offers. The final transaction must still total at least 1000.

Required range: 1 <= x <= 10000000
minimum_amount_minor
integer | null

Required for contribution offers.

Required range: 1000 <= x <= 10000000
maximum_amount_minor
integer | null
Required range: 1000 <= x <= 10000000
suggested_amounts_minor
integer[] | null
Maximum array length: 12
Required range: 1000 <= x <= 10000000
quantity_enabled
boolean
default:false
minimum_quantity
integer
default:1
Required range: 1 <= x <= 100
maximum_quantity
integer
default:1
Required range: 1 <= x <= 100
checkout_fields
object
confirmation
object

Response

Successful data envelope.

data
any
required
meta
object
required