Sign in

v18

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

Create tier structure

<Warning>

<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>

Creates a new tier structure. Depending on type, either point_balance (for POINT_BALANCE) or point_earned (for POINT_EARNED) is required and the other must be null/omitted. If expiration is omitted it defaults to { "type": "NO_EXPIRATION" }; if downgrade is omitted it defaults to { "type": "NO_DOWNGRADE" }; if status is omitted it defaults to DRAFT.

post/v2/loyalties/tier-structures

Request body

namestring required

Display name of the tier structure. Required.

type'POINT_BALANCE' | 'POINT_EARNED' required

Tier qualification tracking model. POINT_BALANCE qualifies members by their current point balance; POINT_EARNED qualifies members by points earned within a tracking period. Required.

metadataobject nullable

Free-form key/value object holding custom attributes.

status'DRAFT' | 'ACTIVE'

Initial status of the tier structure. Defaults to DRAFT when omitted.

Response

The created 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.