Skip to main content
POST
/
v2
/
loyalties
/
tier-structures
/
{tierStructureId}
/
draft
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "name": "<string>",
  "expiration": {
    "fixed_duration": {
      "period": {
        "value": 123
      }
    },
    "calendar_expiration": {
      "calendar_dates": [
        {
          "day": 16,
          "month": 6
        }
      ]
    },
    "sliding_expiration": {
      "earning_activity": true,
      "spending_activity": true,
      "custom_activity": true,
      "custom_activity_types": [
        "<string>"
      ],
      "period": {
        "value": 123
      }
    }
  },
  "downgrade": {
    "grace_period": {
      "value": 123,
      "round_up": true
    }
  },
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>",
  "point_balance": {
    "card_definition_id": "<string>"
  },
  "point_earned": {
    "card_definition_id": "<string>",
    "period": {
      "value": 123
    }
  }
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}
{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}

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

Path Parameters

id
string
required

Unique tier structure identifier.

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

Response

The drafted 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 9, 2026