Skip to main content
POST
Create offer
This reference describes API version 2026-07-24. Send Commet-Version: 2026-07-24 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-07-24

API version used by this reference. Send this header to select this contract explicitly.

Body

application/json
name
string
required
Required string length: 1 - 200
phases
object[]
required
Required array length: 1 - 10 elements
purpose
enum<string>
required
Available options:
introductory,
promotional
planPriceIds
string[]
required
Minimum array length: 1
Minimum string length: 1
metadata
object
startsAt
string<date-time> | null
endsAt
string<date-time> | null
active
boolean
default:true

Response

Success

id
string
required
name
string
required
phases
object[]
required
metadata
object
required
startsAt
string<date-time> | null
required
endsAt
string<date-time> | null
required
active
boolean
required
managedBy
enum<string> | null
required

Integration that manages this record, or null when the merchant does. While an integration manages it, its terms change only in that integration and edits answer 409 managed_by_integration.

Available options:
dub
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
purpose
enum<string>
required
Available options:
introductory,
promotional
planPriceIds
string[]
required
object
string
required
Allowed value: "offer"
livemode
boolean
required