Skip to main content
POST
Create an Offer

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Offer details, accesses and prices.

name
string
required

Offer name. Required when creating and cannot be blank.

Required string length: 1 - 255
title
string | null
Maximum string length: 255
description
string | null
Maximum string length: 200000
long_description
string | null

Formatted offer description. Omit to keep the current description or use null to clear it.

Maximum string length: 200000
is_published
boolean

Whether the offer and payment pages are published. Unpublishing keeps member accesses. Deleting the offer removes them.

is_access_program_shown
boolean | null

Omit to keep the current value. Cannot be null on update.

is_search_engine_indexing_enabled
boolean | null

Omit to keep the current value. Cannot be null on update.

max_purchase_amount
integer | null

Omit to keep the current value. Cannot be null on update.

Required range: x >= 0
trial_period_days
integer | null
Required range: x >= 0
trial_period_days_multiplier
integer | null
Required range: x >= 0
settings_allow_multiple_purchase
boolean
accesses_attributes
object[]
Maximum array length: 100
prices_attributes
object[]

Add prices without an ID. Existing amounts and billing terms cannot be changed. To archive a price, supply its id and _destroy: true. Existing purchases are kept.

Maximum array length: 20
content_format
enum<string>

Format of long_description. Defaults to HTML. Markdown is also supported.

Available options:
html,
markdown

Response

Successful response.

name
string
title
string | null
long_description
string | null
is_published
boolean
is_access_program_shown
boolean | null
is_search_engine_indexing_enabled
boolean | null
max_purchase_amount
integer | null
trial_period_days
integer | null
trial_period_days_multiplier
integer | null
settings_allow_multiple_purchase
boolean
id
string
image_cover_url
string | null
accesses
object[]
prices
object[]