The terminal.offer object
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
terminal.offer Details about the complimentary item offered. Required when type is complimentary_item.
Show child attributes
Show child attributes
Details about the discount offered. Required when type is discount.
Show child attributes
Show child attributes
The date and time at which the offer expires.
The location the offer applies to.
The maximum number of times the offer can be redeemed.
A name for the offer.
1The status of the offer.
active, inactive, expired The terms of service that apply to the offer.
Show child attributes
Show child attributes
A trigger that automatically grants the offer when an event occurs.
Show child attributes
Show child attributes
The type of the offer.
complimentary_item, discount The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Was this page helpful?
{
"id": "<string>",
"created": 123,
"object": "terminal.offer",
"complimentary_item": {},
"discount": {
"amount_off": 1,
"min_spend": 1,
"percent_off": 50
},
"expires_at": 123,
"location": "<string>",
"max_redemptions": 123,
"name": "<string>",
"terms_of_service": {
"text": "<string>"
},
"trigger": {
"type": "move_in"
},
"account": "<string>",
"deleted": false
}