Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

X-App-Id
string
header
required
X-App-Token
string
header
required

Body

application/json

Request body for creating a tier structure. No additional properties are allowed.

name
string
required

Display name of the tier structure. Required.

Required string length: 1 - 200
type
enum<string>
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.

Available options:
POINT_BALANCE,
POINT_EARNED
point_balance
object | null

Point balance tracking settings. Required (non-null) when type is POINT_BALANCE; must be null/omitted when type is POINT_EARNED.

point_earned
object | null

Points earned tracking settings. Required (non-null) when type is POINT_EARNED; must be null/omitted when type is POINT_BALANCE.

expiration
object | null

Tier membership expiration settings. If omitted, defaults to { "type": "NO_EXPIRATION" }.

downgrade
object | null

Downgrade behavior applied when tier membership expires. If omitted, defaults to { "type": "NO_DOWNGRADE" }.

metadata
object | null

Free-form key/value object holding custom attributes.

status
enum<string>

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

Available options:
DRAFT,
ACTIVE

Response

The created tier structure.

Tier structure resource.

id
string
required

Unique tier structure identifier.

Pattern: ^lts_[a-f0-9]+$
name
string
required

Display name of the tier structure.

type
enum<string>
required

Tier qualification tracking model.

Available options:
POINT_BALANCE,
POINT_EARNED
expiration
object
required

Tier membership expiration settings.

downgrade
object
required

Downgrade behavior applied when tier membership expires.

metadata
object
required

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

status
enum<string>
required

Current lifecycle status of the tier structure.

Available options:
DRAFT,
ACTIVE,
INACTIVE,
DELETED
created_at
string<date-time>
required

Creation timestamp (ISO 8601).

updated_at
string<date-time> | null
required

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

object
string
required

Object type discriminator. Always tier_structure.

Allowed value: "tier_structure"
point_balance
object

Point balance tracking settings. Present only when type is POINT_BALANCE; omitted otherwise.

point_earned
object

Points earned tracking settings. Present only when type is POINT_EARNED; omitted otherwise.

Last modified on July 13, 2026