Get the program

GET/v1/program

Returns the program for the brand that owns the key. Cache it for a few minutes; it changes only when someone edits the program in the unPLUG dashboard.

Permissions: Secret key with program:read, or a member token.

Guide

Points and rewards

Response fields#

Returns 200 with Program

brand_idstring (uuid)
Your brand.
namestring
The program name guests see, for example Rewards.
point_nameobject
singular and plural, for example Bean and Beans. Use these in your UI instead of the word "points".
Show attributesHide attributes
- singularstring
- pluralstring
earningobject
Show attributesHide attributes
- typestring
  One of spend, visit
- points_per_dollarinteger
  When type is spend.
- points_per_visitinteger
  When type is visit.
- roundingstring
  One of down
- earn_onstring
  Points are earned on the subtotal after discounts.
  One of subtotal
tiersarray of Tier
Tiers from lowest to highest. Each has id, name, min_lifetime_points and, when the tier gives one, upgrade_bonus_points (points added once when a member moves up into it). Tiers are based on lifetime points, so spending points never drops a member's tier.
Show attributesTier
- idstring (uuid)
- namestring
- min_lifetime_pointsinteger
- upgrade_bonus_pointsinteger
  Points added when a member reaches this tier.
default_time_zonestring
IANA time zone used for anything that has no location, such as birthdays.
currencystring
ISO 4217 code. USD.
points_expiryobjectNullableComing soon
Coming soon { "days_inactive": 365 } when points expire after a period with no activity. Points don't expire at launch, and the field is absent.
Show attributesHide attributes
- days_inactiveinteger

GET/v1/program

1
2curl $UNPLUG_API/program \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/program`, {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    f"{os.environ['UNPLUG_API']}/program",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12{
  "brand_id": "e5a1c7d9-2f4b-4c8e-a3d6-8b0f1e9c2a57",
  "name": "Rewards",
  "point_name": { "singular": "Bean", "plural": "Beans" },
  "earning": { "type": "spend", "points_per_dollar": 10, "rounding": "down", "earn_on": "subtotal" },
  "tiers": [
    { "id": "2b9e4f7a-1c3d-4e6b-8a5f-9d0c2e7b4a13", "name": "Green", "min_lifetime_points": 0 },
    { "id": "6f1a8c3d-9b2e-4d7a-b5c6-3e0f8a1d2b47", "name": "Gold", "min_lifetime_points": 2000, "upgrade_bonus_points": 200 }
  ],
  "default_time_zone": "America/Chicago",
  "currency": "USD"
}

Error descriptions#

401Unauthorized

token_expired

The member token is older than 15 minutes. Get a new one from your server.

Any endpoint can also return the common errors.

401 Unauthorized

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#token_expired",
  "title": "Unauthorized",
  "status": 401,
  "code": "token_expired",
  "detail": "The member token is older than 15 minutes. Get a new one from your server."
}