Tiers

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

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

GET/v2.0/admin/tiers

Query parameters

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurl

const response = await fetch('/v2.0/admin/tiers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}

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

GET/v2.0/admin/tiers/{id}

Path parameters

id*string

The tier segment ID.

Query parameters

Header parameters

Response

200400500

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

Body

application/json

message*string

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.

data*object

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.

Request

JavaScriptCurl

const response = await fetch('/v2.0/admin/tiers/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "text"
}