Authorizations
An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer
token in the Authorization
header
Path Parameters
Your LoyaltyLion Site ID
Query Parameters
The sales channel from which this request is made. Must be provided as this query parameter, or the X-LoyaltyLion-Channel
header
web
, pos
, mobile
Response
200
The sales channel for which this response was generated
web
, pos
, mobile
ISO 4217
code indicating the currency for any financial values in this response
"usd"
ISO 639-1
code indicating the language used for any text in this response
en
, de
, es
, fr
, it
, nl
, sv
The tier configuration for the program, or null
if tiers are not enabled
{
"boundary_mode": "spend",
"tiers": [
{
"id": 1,
"name": "Silver",
"benefit_ids": [1],
"hidden": false,
"kind": "spend",
"position": 1,
"lower_bound": { "amount": 0, "formatted": "$0" },
"upper_bound": { "amount": 99.99, "formatted": "$99.99" }
},
{
"id": 2,
"name": "Gold",
"benefit_ids": [1, 2],
"hidden": false,
"kind": "spend",
"position": 2,
"lower_bound": { "amount": 100, "formatted": "$100" },
"upper_bound": null
}
],
"tier_benefits": [
{
"id": 1,
"label": "Early access to new products",
"secret": false,
"details": null
},
{
"id": 2,
"label": "Free makeup classes",
"secret": false,
"details": {
"plaintext": "Email classes@example.com to sign up to a class\n",
"html": "<p>Email classes@example.com to sign up to a class</p>"
}
}
],
"membership": { "mode": "rolling", "duration_months": 12 }
}
Ordered list of rules that belong to this site. Each rule will have one or more variants that indicate its configuration and if it is enabled per tier. Rules have a kind
property, and some kinds of rules will have properties
that are specific to that rule kind
Ordered list of rewards that belong to this site. Each reward will have one or more variants that indicate its configuration and if it is enabled per tier. Rewards have a kind
property, and some kinds of rewards will have properties
that are specific to that reward kind
The referee incentive for the program, included only if one is enabled. This is a description of the incentive and does not include an actual voucher code, which is available through the referee incentive endpoint instead