Tiers

These endpoints only work for merchants with tiers enabled. Access benefits via this set of endpoints.

get

Returns all tiers/segments for a given merchant. Merchant is pulled from the public API key for security reasons.

Query parameters

includeBenefitsbooleanoptional

Whether or not to include benefits in the response.

Header parameters

X-Inveterate-Api-Keystringrequired

Your private Inveterate API key.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v2.0/admin/tiers' \
  --header 'X-Inveterate-Api-Key: text'

200

400

500

{
  "message": "text",
  "data": {}
}

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

get

Returns a single tier/segment for a given merchant. Merchant is pulled from the public API key for security reasons.

Path parameters

idstringrequired

The tier segment ID.