Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Subscription

Get subscription offer details by ID

Retrieves details of a specific subscription offer by ID

get/subscription/offers/{id}

Path parameters

idstring required
Example:id_1234567890abcdef

Unique identifier of the subscription offer

Response

Get subscription offer details by ID successful

idstring required

The unique identifier of the subscription offer

namestring required

The name of the subscription offer

descriptionstring required

The description of the subscription offer

amountInCentsnumber required

The amount in cents for the subscription offer

entryFeesInCentsnumber nullable

Optional entry fees in cents for the first payment. If set, the first payment will be entryFeesInCents, and subsequent recurring payments will be amountInCents.

currencystring required

The currency of the subscription offer

interval'day' | 'week' | 'month' | 'year' required

The billing interval

intervalCountnumber required

The billing interval count

cycleCountnumber

The cycle count

trialPeriodDaysnumber nullable

Trial period length in days for subscriptions created from this offer. If present and >0, subscriptions will have a free trial period.

isArchivedboolean required

Whether the offer is archived

sessionCustomizationBgColorstring nullable

The background color for the checkout session

sessionCustomizationFontColorstring nullable

The font color for the checkout session

sessionCustomizationLogoUrlstring nullable

The logo URL for the checkout session

sessionCustomizationMerchantNamestring nullable

The merchant name for the checkout session

merchantNamestring nullable

The merchant name from the user account

statementDescriptorstring nullable

Optional statement descriptor (max 11 characters) shown on the customer's bank statement

successUrlstring nullable

The success URL for subscription first payment

cancelUrlstring nullable

The cancel URL for subscription first payment

discordGuildIdstring nullable

Discord server (guild) ID where the role should be assigned

discordRoleIdstring nullable

Discord role ID to assign to subscribers

userIdstring required

The user ID who owns the subscription offer

createdAtstring date-time required

The creation date

updatedAtstring date-time required

The last update date

Example response

{
  "trialPeriodDays": 14
}