# The coupon model

Source: https://developers.swell.is/backend-api/coupons/the-coupon-model

## Fields

- `id` (objectId): Unique identifier for the coupon.
- `name` (string, required): A short descriptive name of the coupon.
- `active` (boolean): Indicates the coupon is currently active. Note: this is not affected by `date_valid` and `date_expired`. Default: `false`.
- `active_generations` (Coupon generation): List of coupon generations that are active.
- `codes` (array of Codes): Expandable list of codes used to identify the coupon.
- `currency` (string): Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
- `date_created` (date): Date and time the coupon was created.
- `date_expired` (date): Date the coupon is considered expired and no longer available for use. When defined, the coupon will not be valid after this date.
- `date_updated` (date): Date and time the coupon was last updated.
- `date_valid` (date): Date the coupon is first available for use. When defined, the coupon will not be valid until after this date and before `date_expired`.
- `description` (string): A brief description of the coupon, as it may be displayed to customers.
- `discount_group` (string): ID of the discount group the coupon belongs to, if applicable, as defined in discount settings. Used to ensure only one set of discount rules can apply across a number of coupons and promotions.
- `discounts` (array of object): List of discount rules to apply.
  - `type` (enum): Type of discount to apply. Can be `total`, `product`, `category`, or `shipment`. Possible values: `total`, `shipment`, `product`, `category`, `buy_get`. Default: `"total"`.
  - `value_type` (enum, required): Type of value to calculate discount amount. Can be `fixed` or `percent`. Possible values: `fixed`, `percent`. Default: `"fixed"`.
  - `purchase_option` (enum): Purchase option the discount applies to. Possible values: `standard`, `subscription`, `subscription_plan`.
  - `subscription_plan_id` (objectId): ID of the subscription plan the discount applies to, when `purchase_option` is `subscription_plan`.
  - `category_id` (objectId): ID of the category to discount, if applicable.
  - `category` (category): Expandable link to the discounted category, if applicable.
  - `exclude_category_ids` (array of child_scalar): List of category IDs to exclude from discount, applicable to category discounts when several categories overlap.
  - `exclude_categories` (exclude_categories): Expandable list of excluded categories, if applicable.
  - `price_min` (currency): Minimum product price required for the rule to apply, applicable for category and product discounts.
  - `product_id` (objectId): ID of the product to discount, if applicable.
  - `product` (product): Expandable link to the discounted product, if applicable.
  - `quantity_add` (int): Quantity of the product to add to cart, if applicable.
  - `quantity_max` (int): Maximum product quantity required for the rule to apply, applicable for category and product discounts.
  - `quantity_min` (int): Minimum product quantity required for the rule to apply, applicable for category and product discounts.
  - `shipment_service` (string): ID of the shipping service to discount, if applicable.
  - `total_min` (currency): Minimum order total required for the rule to apply.
  - `value_fixed` (currency): Fixed discount applied when `value_type=fixed`.
  - `value_percent` (float): Percentage discount applied when `value_type=percent`.
  - `variant_id` (objectId): ID of the variant to discount, if applicable.
  - `variant` (variant): Expandable link to the discounted variant, if applicable.
  - `buy_items` (array of object): Items required to be purchased in order to receive the coupon.
    - `product_id` (objectId): Unique identifier for the product.
    - `product` (product): Expandable link to the product.
    - `category_id` (objectId): Unique identifier for the category.
    - `category` (category, required): Expandable link to the category.
  - `get_items` (array of object): Eligible discounted items available once a coupon's `buy_items` requirements are met.
    - `product_id` (objectId): Unique identifier for the product.
    - `product` (product): Expandable link to the product.
    - `category_id` (objectId): Unique identifier for the category.
    - `category` (category): Expandable link to the category.
  - `get_total` (boolean): Indicates whether the `get_items` promotion requirements have been met.
  - `discount_max` (currency): Maximum redeemable discount amount for the coupon.
- `generations` (array of Generations): List of coupon generations.
- `limit_code_uses` (int): Maximum number of times each coupon code can be applied. Mainly used with multiple codes.
- `limit_uses` (int): Maximum number of times the coupon can be applied across all customers.
- `limit_account_uses` (int): Maximum number of times the coupon can be used by each customer account.
- `limit_account_groups` (array of account_groups): List of customer account groups allowed to use the coupon.
- `limit_account_segments` (array of string): List of account segments for which the coupon is avaialble.
- `limit_subscription_uses` (int): Maximum number of invoices the promotion may be applied to for a subscription.
- `multi_codes` (boolean): Indicates the coupon is identified by multiple coupon codes. Default: `false`.
- `orders` (Order): Expandable list of orders that have applied the coupon.
- `subscriptions` (Subscription): Expandable list of subscriptions that have applied the coupon.
- `use_count` (int): Number of times the coupon has been used.
- `uses` (array of Uses): Expandable list of coupon code usage records.

## Example response

```json
{
  "id": "60f199509111e70000000015",
  "name": "10% Off Winter Jacket Sale",
  "active": true,
  "codes": [
    {
      "code": "WINTER10"
    }
  ],
  "currency": "USD",
  "date_created": "2021-07-16T14:36:00.100Z",
  "date_expired": "2018-03-01T00:00:00.000Z",
  "date_updated": "2021-07-16T14:36:00.100Z",
  "date_valid": "2018-11-01T00:00:00.000Z",
  "description": "Save 10% on all Winter Jackets for a limited time only.",
  "discount_group": null,
  "discounts": [
    {
      "type": "category",
      "category_id": "5a97242bc65396a875c2d381",
      "value_type": "percent",
      "value_fixed": 10
    }
  ],
  "limit_account_uses": 3,
  "limit_code_uses": 10,
  "limit_uses": 300,
  "multi_codes": false,
  "use_count": 184
}
```