curl --request POST \
--url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/deactivate \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"card_definition_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"point_earned": {
"period": {
"value": 2
}
},
"expiration": {
"rolling_expiration": {
"period": {
"value": 2
}
},
"calendar_expiration": {
"calendar_dates": [
{
"day": 16,
"month": 6
}
]
},
"sliding_expiration": {
"earning_activity": true,
"spending_activity": true,
"custom_activity": true,
"period": {
"value": 2
},
"custom_activity_types": [
"<string>"
]
}
},
"downgrade": {
"grace_period": {
"value": 2,
"round_up": true
}
},
"updated_at": "2023-11-07T05:31:56Z"
}Deactivate Tier Structure
⚠️ BETA endpoint
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.
Transitions a tier structure to INACTIVE status.
Allowed from: ACTIVE.
curl --request POST \
--url https://api.voucherify.io/v2/loyalties/tier-structures/{id}/deactivate \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"id": "<string>",
"name": "<string>",
"card_definition_id": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"point_earned": {
"period": {
"value": 2
}
},
"expiration": {
"rolling_expiration": {
"period": {
"value": 2
}
},
"calendar_expiration": {
"calendar_dates": [
{
"day": 16,
"month": 6
}
]
},
"sliding_expiration": {
"earning_activity": true,
"spending_activity": true,
"custom_activity": true,
"period": {
"value": 2
},
"custom_activity_types": [
"<string>"
]
}
},
"downgrade": {
"grace_period": {
"value": 2,
"round_up": true
}
},
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique tier structure identifier.
Response
Deactivated tier structure
A tier structure resource as returned by the API.
Unique tier structure identifier.
Display name.
200Tiering model type.
POINT_BALANCE, POINT_EARNED ID of the linked card definition.
Custom key-value metadata.
Current lifecycle status.
DRAFT, ACTIVE, INACTIVE, DELETED ISO 8601 creation timestamp.
Object type discriminator.
tier_structure Point-earned tracking configuration. Present when type is POINT_EARNED.
Show child attributes
Show child attributes
Tier qualification expiration settings.
Show child attributes
Show child attributes
Downgrade behaviour settings.
Show child attributes
Show child attributes
ISO 8601 last-update timestamp.
Was this page helpful?

