Get a redemption

GET/v1/redemptions/{id}

Returns a redemption. Use it after a timeout to see whether the hold is still reserved before you send the order.

Permissions: Secret key with checkout:write, or a member token for its own member's redemptions.

Guide

Checkout and orders

Path parameters#

idstring (uuid)Required

Response fields#

Returns 200 with Redemption

idstring (uuid)
Send it in redemption_ids on the order.
statusstring
See Redemption statuses.
One of reserved, captured, canceled, expired, reversed
member_idstring (uuid)Nullable
null for a guest code.
reward_idstring (uuid)Nullable
What was redeemed. One is set.
wallet_item_idstring (uuid)Nullable
What was redeemed. One is set.
codestringNullable
What was redeemed. One is set.
discount_centsinteger
The discount on the cart it was created for.
Min 0
points_costinteger
Points held, then spent on capture. 0 for wallet items and codes.
affected_line_idsarray of string
Cart lines the discount applies to.
order_idstring (uuid)Nullable
The order that captured it.
expires_atstring (date-time)
End of the hold, 15 minutes after creation.
created_atstring (date-time)

GET/v1/redemptions/{id}

1
2curl $UNPLUG_API/redemptions/4b8d2f6a-9c1e-4a3d-b7f5-0e6c8a2d1b59 \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch(`${process.env.UNPLUG_API}/redemptions/4b8d2f6a-9c1e-4a3d-b7f5-0e6c8a2d1b59`, {
  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']}/redemptions/4b8d2f6a-9c1e-4a3d-b7f5-0e6c8a2d1b59",
    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
13
14{
  "id": "4b8d2f6a-9c1e-4a3d-b7f5-0e6c8a2d1b59",
  "status": "reserved",
  "member_id": "3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40",
  "reward_id": null,
  "wallet_item_id": "7e3a9c51-0b8d-4f2e-a6c4-5d1b9e7f3a28",
  "code": null,
  "discount_cents": 350,
  "points_cost": 0,
  "affected_line_ids": ["3"],
  "order_id": null,
  "expires_at": "2026-11-05T14:22:02Z",
  "created_at": "2026-11-05T14:07:02Z"
}

Error descriptions#

404Not found

not_found

No redemption with this id in your brand, or it belongs to another member (member token).

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#not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "No redemption with this id in your brand, or it belongs to another member (member token)."
}