v18

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01934981.1 MB

Tier Structures

Get tier structure

<Badge color="yellow">BETA endpoint</Badge>

This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.

</Warning>

Returns a single tier structure by its id.

get/v2/loyalties/tier-structures/{tierStructureId}

Path parameters

idstring required

Unique tier structure identifier.

Response

The tier structure.

idstring required

Unique tier structure identifier.

namestring required

Display name of the tier structure.

type'POINT_BALANCE' | 'POINT_EARNED' required

Tier qualification tracking model.

metadataobject required

Free-form key/value object holding custom attributes. Defaults to {}.

status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DELETED' required

Current lifecycle status of the tier structure.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time nullable required

Last update timestamp (ISO 8601), or null if never updated.

object'tier_structure' required

Object type discriminator. Always tier_structure.