Expire wallet items

POST/v1/test/members/{id}/expire_wallet_items

Expires every available item in the member's wallet now. Use it to test how your app handles an expired reward, and what happens when a guest pays with a wallet item that expired after preview.

Maya's two pastries are now expired. They no longer appear in GET /v1/members/me/wallet without a filter, and a redemption that names one fails with 422 reward_expired.

Permissions: Sandbox secret key.

Guide

Sandbox

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with object

expiredinteger

POST/v1/test/members/{id}/expire_wallet_items

1
2curl -X POST $UNPLUG_API/test/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/expire_wallet_items \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch(`${process.env.UNPLUG_API}/test/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/expire_wallet_items`, {
  method: "POST",
  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.post(
    f"{os.environ['UNPLUG_API']}/test/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/expire_wallet_items",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3{
  "expired": 2
}

Error descriptions#

404Not found

member_not_found

No member with this id.

404Not found

not_found

Called on production.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}