> For the complete documentation index, see [llms.txt](https://docs.commercelayer.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.commercelayer.io/core-api-reference/coupons/object.md). # The coupon object A comprehensive list of the coupon resource's attributes and relationships A coupon object is returned as part of the response body of each successful list, retrieve, create or update API call to the `/api/coupons` endpoint. ## Fields | Field | Type | Description | | ------------------------------------ | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **type** | `string` | `coupons` | | **id** | `string` | The coupon unique identifier | | links.**self** | `string` | The coupon endpoint URL | | attributes.**code** | `string` | The coupon code, that uniquely identifies the coupon within the promotion rule. | | attributes.**customer\_single\_use** | `boolean` | Indicates if the coupon can be used just once per customer. | | attributes.**usage\_limit** | `integer` | The total number of times this coupon can be used. | | attributes.**usage\_count** | `integer` | The number of times this coupon has been used. | | attributes.**recipient\_email** | `string` | The email address of the associated recipient. When creating or updating a coupon, this is a shortcut to find or create the associated recipient by email. | | attributes.**expires\_at** | `string` | Time at which the coupon will expire. | | attributes.**\_add\_tags** | `string` | Comma separated list of tags to be added. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. | | attributes.**\_remove\_tags** | `string` | Comma separated list of tags to be removed. Duplicates, invalid and non existing ones are discarded. Cannot be passed by sales channels. | | attributes.**created\_at** | `string` | Time at which the resource was created. | | attributes.**updated\_at** | `string` | Time at which the resource was last updated. | | attributes.**reference** | `string` | A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. | | attributes.**reference\_origin** | `string` | Any identifier of the third party system that defines the reference code. | | attributes.**metadata** | `object` | Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. | | relationships.**promotion\_rule** | `object` | The associated promotion rule. | | relationships.**coupon\_recipient** | `object` | The associated coupon recipient (optional). | | relationships.**events** | `array` | The associated events. | | relationships.**tags** | `array` | The associated tags. Cannot be passed by sales channels. | | relationships.**event\_stores** | `array` | The associated event stores. | | meta.**mode** | `string` | The resource environment (can be one of `test` or `live`) | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.commercelayer.io/core-api-reference/coupons/object.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.