Get Tiers Configurations

Parameters

merchant_id

string

Only return tier configuration for this merchant

Response

merchant_id

string

The merchant ID

bronze_tier

hash

Describes the configuration for the bronze tier

string

The identifer of the tier record

name

string

The display name for the tier

description

string

Describes the perks of the tier. Can return markdown.

color

string

The hex color to use for this tier.

spend_threshold

integer

How much the user needs to spend to be part of the tier.

progress_paddle_image

hash

The image configured to render on the progress bar for tiers

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

background_image

hash

The image configured to render as the background for the tier

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

icon_image

hash

The image configured to render as the icon for the tier

icon_image.small

string

The url for the small version of this image

icon_image.large

string

The url for the large version of this image

icon_image.default

string

The url for the version of the image usually used by Thanx

silver_tier

hash

Describes the configuration for the silver tier

string

The identifer of the tier record

name

string

The display name for the tier

description

string

Describes the perks of the tier. Can return markdown.

color

string

The hex color to use for this tier.

spend_threshold

integer

How much the user needs to spend to be part of the tier.

progress_paddle_image

hash

The image configured to render on the progress bar for tiers

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

background_image

hash

The image configured to render as the background for the tier

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

icon_image

string

The image configured to render as the icon for the tier

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

gold_tier

string

Describes the configuration for the gold tier

string

The identifer of the tier record

name

string

The display name for the tier

description

string

Describes the perks of the tier. Can return markdown.

color

string

The hex color to use for this tier.

spend_threshold

integer

How much the user needs to spend to be part of the tier.

progress_paddle_image

hash

The image configured to render on the progress bar for tiers

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

background_image

hash

The image configured to render as the background for the tier

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

icon_image

hash

The image configured to render as the icon for the tier

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

progress_bar_image

hash

The image configured to render as the progress bar for tiers

small

string

The url for the small version of this image

large

string

The url for the large version of this image

default

string

The url for the version of the image usually used by Thanx

Consumer API

Reference

Get Tiers Configurations

Parameters

Response

Consumer API

Reference

​Parameters

​Response

Parameters

Response