Get Offer

GET 
/courses/offers/:offerId

Get a membership offer by id. Requires a Location token with courses.readonly. Send Version: v3. Default-offer rows (source other than membership) return 404.

Request

Version stringrequired

API Version

Available optionsv3

offerId string<uuid>required

Offer id

Possible values: non-empty

locationId stringrequired

Location id or sub-account id is required.

Possible values: non-empty

application/json

Success

application/json

Schema

Schema

idstringrequired
titlestringrequired
descriptionstringnullablerequired
typestringrequired
Available optionsfreeonetimesubscription
sourcestringrequired
amountnumbernullablerequired
currencystringnullablerequired
priceDisplayOverridestringnullablerequired
isLivePaymentModebooleannullablerequired
intervalstringnullablerequired
Available optionsweekmonthyearday
intervalCountnumbernullablerequired
trialDaysnumbernullablerequired
setupFeenumbernullablerequired
numberOfPaymentsnumbernullablerequired
visibilitystringrequired
Available optionspublisheddraft
accessDatestringnullablerequired
daysOfAccessnumbernullablerequired
customJsstringnullablerequired
customCssstringnullablerequired
customHeaderstringnullablerequired
customFooterstringnullablerequired
couponsobject[]nullablerequired
posterImagestringnullablerequired
paymentProductIdstringnullablerequired

Read-only Payments catalog id generated by membership

paymentPriceIdstringnullablerequired

Read-only Payments price id generated by membership

productsobject[]required
createdAtstringrequired
updatedAtstringrequired

Example (auto)

{
  "id": "c3d4e5f6-7890-4123-cdef-123456789012",
  "title": "Founding members",
  "description": "string",
  "type": "free",
  "source": "membership",
  "amount": 0,
  "currency": "string",
  "priceDisplayOverride": "string",
  "isLivePaymentMode": true,
  "interval": "week",
  "intervalCount": 0,
  "trialDays": 0,
  "setupFee": 0,
  "numberOfPayments": 0,
  "visibility": "published",
  "accessDate": "string",
  "daysOfAccess": 0,
  "customJs": "string",
  "customCss": "string",
  "customHeader": "string",
  "customFooter": "string",
  "coupons": [
    {}
  ],
  "posterImage": "string",
  "paymentProductId": "string",
  "paymentPriceId": "string",
  "products": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "title": "Onboarding",
      "description": "Start here"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string"
}