Skip to content

List a tier's benefits

Request

This endpoint will return all benefits for a merchant under a given tier. It will return an array of benefits. Each benefit will have a type field that will identify the type of benefit.

Security
api_key
Path
idstringrequired

The customer ID.

curl -i -X GET \
  'https://public.inveterateapi.com/v2.0/storefront/tiers/{id}/benefits' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE'

Responses

Returned upon successful direct action to our database. Action is immediate.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Success",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}