Skip to main content
Use offers to create a discount or special price for members signing up on a tier.

​
The offer object

When you fetch, create, or edit an offer, the API responds with an array of one or more offer objects. These objects include related tier data. 
// GET /admin/offers/
{
    "offers": [
        {
            "id": "6230dd69e8bc4d3097caefd3",
            "name": "Black friday",
            "code": "black-friday",
            "display_title": "Black friday sale!",
            "display_description": "10% off our yearly price",
            "type": "percent",
            "cadence": "year",
            "amount": 10,
            "duration": "once",
            "duration_in_months": null,
            "currency_restriction": false,
            "currency": null,
            "status": "active",
            "redemption_count": 0,
            "tier": {
                "id": "62307cc71b4376a976734038",
                "name": "Platinum"
            }
        }
    ]
}
KeyDescription
display_titleName displayed in the offer window
display_descriptionText displayed in the offer window
nameInternal name for an offer, must be unique
codeShortcode for the offer, for example: https://yoursite.com/black-friday
statusactive or archived - denotes if the offer is active or archived
typepercent or fixed - whether the amount off is a percentage or fixed
amountOffer discount amount, as a percentage or fixed value as set in type. Amount is always denoted by the smallest currency unit (e.g., 100 cents instead of $1.00 in USD)
currencyfixed type offers only - specifies tier’s currency as three letter ISO currency code
currency_restrictionDenotes whether the offer `currency` is restricted. If so, changing the currency invalidates the offer
durationonce/forever/repeating. repeating duration is only available when cadence is month
duration_in_monthsNumber of months offer should be repeated when duration is repeating
redemption_countNumber of times the offer has been redeemed
tierTier on which offer is applied
cadencemonth or year - denotes if offer applies to tier’s monthly or yearly price