Skip to main content
GET
/
v2
/
customers
/
{customer_id}
/
rewards_balance
Get customer's current rewards balance
curl --request GET \
  --url https://dev.sbx.imprint.co/v2/customers/{customer_id}/rewards_balance \
  --header 'Authorization: Bearer <token>'
{
  "customer_id": "2EE24580-B97B-4949-A65C-929CCB9B9B8D",
  "reward_balance": 120000,
  "reward_symbol": "<string>",
  "reward_description": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Path Parameters

​
customer_id
string
required

The unique identifier for the Imprint customer

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

Response

Customer rewards balance

​
customer_id
string
required

The unique identifier for the customer

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

​
reward_balance
integer
required

The integer value of the customer's rewards balance

Example:

120000

​
reward_symbol
string
required

The symbol for the rewards. Can be in currency like $ or things like points

​
reward_description
string

The description of the rewards, can be displayed to the customer