List wallet items

GET/v1/members/{id}/wallet

GET/v1/members/me/wallet

Returns the member's wallet items. Without a filter you get only available items, which is what a rewards screen shows.

Permissions: {id}: secret key with members:read. me: member token.

Guide

Points and rewards

Path parameters#

idstring (uuid)Required

Query parameters#

statusstring
available (default), reserved, used or expired.
Default available
One of available, reserved, used, expired
limitinteger
1 to 100. Default 25.
Min 1Max 100Default 25
cursorstring
next_cursor from the previous page. See Pagination.

Show expires_at next to each item, in the guest's time zone: Maya's pastry expires at the end of November 12 in Austin. To know whether an item works on the current cart (right items, right time, right location), call preview; don't check the rules yourself.

Response fields#

Returns 200 with list of WalletItem

dataarray of WalletItem
Show attributesWalletItem
- idstring (uuid)
  Send this as wallet_item_id on previews and redemptions.
- rewardReward
  The reward, in the same shape as the catalog, with kind: "wallet" and no points_cost. Its rules apply at checkout.
  Show attributesReward
  - idstring (uuid)
    Send this as reward_id on previews and redemptions.
  - namestring
    For example Free drip coffee.
  - descriptionstring
    Short text for the guest.
  - image_urlstring (uri)Nullable
    HTTPS image URL.
  - kindstring
    points (catalog) or wallet (given to one member). May grow.
    One of points, wallet
  - points_costinteger
    Points the reward costs. Only on points rewards; wallet rewards don't have it.
  - discountDiscount
    Show attributesDiscount
    typestring
    One of amount, percent, free_item, bogo
    amount_centsinteger
    For amount.
    percentnumber
    For percent.
    itemsarray of object
    Item scope, by Square variation id.
    categoriesarray of object
    Category scope.
    max_itemsinteger
  - rulesRules
    Show attributesRules
    min_subtotal_centsinteger
    Integer cents.
    Min 0
    channelsarray of string
    One of app, web
    location_idsarray of string (uuid)
    fulfillmentarray of string
    One of pickup, delivery, curbside, dine_in
    available_timesarray of AvailableTime
    tier_idsarray of string (uuid)
  - starts_atstring (date-time)Nullable
    When the reward becomes available. null means it already is.
  - ends_atstring (date-time)Nullable
    When it stops being available. null means no end date.
- sourcestring
  How the member got it. See the table below. May grow.
  One of tier, offer, challenge, journey, support, birthday
- offer_idstring (uuid)Nullable
  The offer, when source is offer.
- statusstring
  available, reserved, used or expired.
  One of available, reserved, used, expired
- issued_atstring (date-time)
  When it landed in the wallet.
- expires_atstring (date-time)Nullable
  After this time it can't be used. null means it doesn't expire.
- used_atstring (date-time)Nullable
  When an order used it.
- order_idstring (uuid)Nullable
  The order that used it.
has_moreboolean
True when another page exists.
next_cursorstringNullable
Pass as cursor to get the next page.

GET/v1/members/{id}/wallet

1
2curl $UNPLUG_API/members/me/wallet \
  -H "Authorization: Bearer $MEMBER_TOKEN"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/members/me/wallet`, {
  headers: {
    Authorization: `Bearer ${process.env.MEMBER_TOKEN}`,
  },
});
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']}/members/me/wallet",
    headers={
        "Authorization": f"Bearer {os.environ['MEMBER_TOKEN']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31{
  "data": [
    {
      "id": "7e3a9c51-0b8d-4f2e-a6c4-5d1b9e7f3a28",
      "reward": {
        "id": "d4c2e8a6-7b3f-4e1d-9a5c-1f8b6d3e0a92",
        "name": "Fall pastry on us",
        "description": "Any pastry, one per order.",
        "image_url": "https://cdn.unplugdining.com/rewards/d4c2e8a6.jpg",
        "kind": "wallet",
        "discount": {
          "type": "free_item",
          "categories": [ { "pos_category_id": "P9MT2XQ6KZR4WLN8HCB3J7VD", "name": "Pastries" } ],
          "max_items": 1
        },
        "rules": { "min_subtotal_cents": 0, "channels": ["app", "web"], "location_ids": [], "fulfillment": [], "available_times": [], "tier_ids": [] },
        "starts_at": null,
        "ends_at": null
      },
      "source": "offer",
      "offer_id": "a8f2d6b4-3e9c-4a7f-8d1e-6c5b2a0f9e37",
      "status": "available",
      "issued_at": "2026-10-30T15:00:00Z",
      "expires_at": "2026-11-13T05:59:59Z",
      "used_at": null,
      "order_id": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Error descriptions#

400Bad request

invalid_param

status isn't one of the four values.

401Unauthorized

token_expired

The member token expired. Get a new one from your server.

404Not found

member_not_found

No member with this id.

410Gone

member_deleted

The member was deleted.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#invalid_param",
  "title": "Bad request",
  "status": 400,
  "code": "invalid_param",
  "detail": "status isn't one of the four values."
}