OfferVersion: v3New
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.
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
courses.Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
offerIdstring<uuid>required
Offer id
Possible values: non-empty
Example:
c3d4e5f6-7890-4123-cdef-123456789012Query Parameters
locationIdstringrequired
Location id or sub-account id is required.
Possible values: non-empty
Example:
ve9EPM428h8vShlRW1KTResponse
Success
idstringrequired
Example:
c3d4e5f6-7890-4123-cdef-123456789012titlestringrequired
Example:
Founding membersdescriptionstringnullablerequired
typestringrequired
Available options
freeonetimesubscriptionsourcestringrequired
Example:
membershipamountnumbernullablerequired
currencystringnullablerequired
priceDisplayOverridestringnullablerequired
isLivePaymentModebooleannullablerequired
intervalstringnullablerequired
Available options
weekmonthyeardayintervalCountnumbernullablerequired
trialDaysnumbernullablerequired
setupFeenumbernullablerequired
numberOfPaymentsnumbernullablerequired
visibilitystringrequired
Available options
publisheddraftaccessDatestringnullablerequired
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