Entity description
A coupon is a promotional code or discount mechanism for a business. It can be applied to specific services or staff members for a specified period. Coupons may provide either a fixed amount or percentage discount.
Properties
| Name | Description | Type | Example |
|---|---|---|---|
| uid | The unique identifier (UID) of the coupon | string | 56a78b56c |
| business_uid | The unique identifier (UID) of the business the coupon belongs to | string | hfjds47r534 |
| coupon_name | A human-readable name for the coupon | string | Summer 2024 |
| discount_type | Type of discount offered: fixed for a fixed amount, percent for a percentage discount | string | fixed |
| discount_value | The discount amount (decimal) provided by applying the coupon. For a fixed type, this is the monetary amount (e.g., $5.5). For a percent type, this is the percentage discount (e.g., 5.3%). | number | 20 |
| coupon_code | A unique identifier or code for the coupon | string | SAVE20 |
| status | The status of the coupon: active, scheduled, or expired | string | active |
| valid_for_services | A list of services (UIDs) where the coupon can be applied | array | ["5ya4gbwm2c3qoic8"] |
| valid_for_staff | A list of staff members (UIDs) where the coupon can be applied | array | ["0c4ac9717ab26f56"] |
| start_date | The start date when the coupon becomes active, in ISO 8601 format | string | 2024-03-20T12:34:56Z |
| expiration_date | The expiry date when the coupon is no longer valid, in ISO 8601 format | string | 2024-01-01T09:00:00Z |
| max_redemptions | The maximum number of times the coupon can be used | number | 100 |
| max_redemptions_per_client | The maximum number of times an individual client can use the coupon | number | 1 |
| total_redemptions | The total number of times the coupon has been redeemed | number | 23 |
| created_at | The creation date and time of the coupon, in ISO 8601 format | string | 2021-07-20T14:00:00.000Z |
| updated_at | The last updated date and time of the coupon, in ISO 8601 format | string | 2021-07-20T14:00:00.000Z |
Example
{
"uid": "56a78b56c",
"business_uid": "hfjds47r534",
"coupon_name": "Summer 2024",
"discount_type": "fixed",
"discount_value": 20,
"coupon_code": "SAVE20",
"status": "active",
"valid_for_services": ["5ya4gbwm2c3qoic8"],
"valid_for_staff": ["0c4ac9717ab26f56"],
"start_date": "2024-03-20T12:34:56Z",
"expiration_date": "2024-01-01T09:00:00Z",
"max_redemptions": 100,
"max_redemptions_per_client": 1,
"total_redemptions": 23,
"created_at": "2021-07-20T14:00:00.000Z",
"updated_at": "2021-07-20T14:00:00.000Z"
}