Tier Structures

Create tier structure

<Info>

<Badge color="gray">Documentation in progress</Badge>

This documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact Voucherify support or your Technical Account Manager.

</Info>

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_RETENTION" }; 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.

Changes

Changed in 4 of the 62 revisions of this API.241137

Jul 31, 2026v2703a0a42ea43322See the full diff
- ▲
  added subschema #2 subschema #3 to the request body allOf list
  request-body-all-of-added
- ▲
  the request property const value changed from NO_EXPIRATION to NO_RETENTION
  request-property-const-changed
- ▲
  removed the enum value NO_EXPIRATION of the request property /////
  request-property-enum-value-removed
- ●
  removed subschema #2 subschema #3 from the request body allOf list
  request-body-all-of-removed
- ●
  added the new NO_RETENTION enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the new NO_RETENTION enum value to the request property /////
  request-property-enum-value-added
- ○
  removed the NO_EXPIRATION enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 17, 2026v24cbaee5a82d58See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jul 17, 2026v226ef7b3dd1ef22See the full diff
- ▲
  added subschema #2 subschema #3 to the request body allOf list
  request-body-all-of-added
- ▲
  added subschema #3 subschema #4 subschema #5 to the //// request property allOf list
  request-property-all-of-added
- ●
  removed subschema #2 subschema #3 from the request body allOf list
  request-body-all-of-removed
- ●
  removed subschema #3 subschema #4 subschema #5 from the //// request property allOf list
  request-property-all-of-removed
Jul 6, 2026v2341403eb19e519727See the full diff
- ▲
  added subschema #1 subschema #2 subschema #3 to the request body allOf list
  request-body-all-of-added
- ▲
  removed from the request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the request property oneOf list
  request-property-one-of-removed
- ▲
  removed from the request property oneOf list
  request-property-one-of-removed
- ▲
  the response property became nullable for the status
  response-property-became-nullable
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property became optional for the status
  response-property-became-optional
- ▲
  the response property's maxLength was unset from 200 for the response status
  response-property-max-length-unset
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ●
  removed the request property
  request-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ○
  added the new optional request property
  new-optional-request-property
- ○
  the request property became optional
  request-property-became-optional
- ○
  the request property became optional
  request-property-became-optional
- ○
  added to the request property oneOf list
  request-property-one-of-added
- ○
  added to the request property oneOf list
  request-property-one-of-added
- ○
  added to the request property oneOf list
  request-property-one-of-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property became required for the status
  response-property-became-required
- ○
  the response property const value tier_structure was added for the status
  response-property-const-added
- ○
  removed the tier_structure enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  response property updated_at list-of-types was narrowed by removing types null from media type application/json of response 200
  response-property-list-of-types-narrowed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed subschema #2 from the response property oneOf list for the response status
  response-property-one-of-removed
- ○
  the response's property pattern ^lts_[a-f0-9]+$ was added for the status
  response-property-pattern-added
This revision also has 292 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history