DiscountCodes
Create DiscountCode
Create a new DiscountCode record.
POST
A DiscountCode represents a discount registered in the system. Each discount code belongs to a
Business (location) and defines a percentage or fixed-amount discount that can be applied to different item types: price plans (tariffs), bookings, products, and/or events.
Use the boolean flags (DiscountPricePlans, DiscountBookings, DiscountProducts, DiscountEvents) to control which item categories the discount applies to. For each enabled category, associate the specific eligible items via the corresponding ID list (e.g. Tariffs, ResourceTypes, Products, EventCategories). Use the Added* and Removed* list variants for incremental updates without replacing the full list.
A discount can specify either DiscountPercentage (e.g. 10 for 10% off) or DiscountAmount (a fixed monetary amount off), but not both.
Discount codes can be assigned to individual customers via CoworkerDiscountCode. Availability can be further restricted by validity dates (ValidFrom/ValidTo), publish window (PublishFrom/PublishTo), usage caps (MaxUses, MaxUsesPerUser), audience (OnlyForContacts, OnlyForMembers), and expiration rules (ExpirationType, ExpiresIn).
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the DiscountCode-Create role.Enums
eDiscountExpirePeriod
eDiscountExpirePeriod
| Value | Name |
|---|---|
| 1 | Day |
| 2 | Week |
| 3 | Month |
| 4 | Year |
Request Body
Required Fields
Business Id.
The unique alphanumeric code customers enter to apply the discount.
Human-readable description of what this discount code is for.
Optional Fields
Whether this discount code is currently active and can be redeemed.
Date from which this discount code is visible/published to customers.
Date until which this discount code is visible/published to customers.
Percentage discount to apply (e.g. 10 for 10% off). Mutually exclusive with DiscountAmount.
Fixed monetary amount to discount. Mutually exclusive with DiscountPercentage.
Whether this discount code is used as part of the referral program.
Whether this discount can be applied to price plans (tariffs). When true, use Tariffs to restrict to specific plans.
Tariffs.
Whether this discount can be applied to resource bookings. When true, use ResourceTypes to restrict to specific resource types.
Resource Types.
Whether this discount can be applied to products. When true, use Products to restrict to specific products.
Products.
Whether this discount can be applied to events. When true, use EventCategories to restrict to specific event categories.
Event Categories.
Maximum number of times a single customer can redeem this discount code.
Maximum total number of times this discount code can be redeemed across all customers.
When true, only contacts (non-member customers) can use this discount code.
When true, only members (customers with an active plan) can use this discount code.
Start date from which this discount code can be redeemed.
End date after which this discount code can no longer be redeemed.
Unit of the expiration period (Day, Week, Month, Year). Used with ExpiresIn to determine when the discount expires after being assigned to a customer. See
eDiscountExpirePeriod? enum above.Number of ExpirationType periods after assignment until the discount expires for a customer.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the discountcode was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response