# Coupon uses

Coupons used in bookings

Endpoint: `https://api.bookingmood.com/v1/coupon_uses`, supporting `GET`, `POST`, `DELETE`, `PATCH`. Authenticate with the header `Authorization: Bearer YOUR_API_KEY` (see [authentication](https://www.bookingmood.com/fr-FR/api-reference/authentication.md)).

## The coupon use object

| Attribute | Type | Description |
| --- | --- | --- |
| `id` | `uuid` | Unique identifier. |
| `booking_id` | `uuid` | Identifier of the booking the coupon is used in. References [`bookings.id`](https://www.bookingmood.com/fr-FR/api-reference/bookings.md). |
| `coupon_id` | `uuid` | Identifier of the used coupon. References [`coupons.id`](https://www.bookingmood.com/fr-FR/api-reference/coupons.md). |
| `created_at` | `timestamp with time zone` | Creation timestamp. Read-only: set by the database. |

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "booking_id": "00000000-0000-0000-0000-000000000000",
  "coupon_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-10-30T22:25:29.937Z"
}
```

### Related resources

Embed related resources with the [`select` parameter](https://www.bookingmood.com/fr-FR/api-reference/selecting.md), e.g. `select=*,bookings(*)`. Resources related through more than one column need the column as a hint, like `table!column(*)`.

| Embed | Type | Description |
| --- | --- | --- |
| `bookings(*)` | `object \| null` | The [booking](https://www.bookingmood.com/fr-FR/api-reference/bookings.md) referenced by `booking_id`. |
| `coupons(*)` | `object \| null` | The [coupon](https://www.bookingmood.com/fr-FR/api-reference/coupons.md) referenced by `coupon_id`. |

## List coupon uses

`GET /v1/coupon_uses`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/fr-FR/api-reference/filtering.md)). Choose columns and embed related resources with `select` (see [selecting](https://www.bookingmood.com/fr-FR/api-reference/selecting.md)), and sort and paginate with `order`, `limit` and `offset` (see [sorting and pagination](https://www.bookingmood.com/fr-FR/api-reference/sorting-pagination.md)).

```bash
curl -X GET "https://api.bookingmood.com/v1/coupon_uses?select=*&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: A list of coupon uses with the selected columns. `206` when the list is a partial range.
- `400`: The request is malformed, for example an unknown column or an invalid filter.
- `401`: The API key is missing or invalid.

## Create coupon uses

`POST /v1/coupon_uses`

Insert one coupon use or an array of coupon uses. The body is a `Partial` coupon use object, so columns with a default can be left out. Read-only attributes can't be written.

```bash
curl -X POST "https://api.bookingmood.com/v1/coupon_uses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "booking_id": "00000000-0000-0000-0000-000000000000",
    "coupon_id": "00000000-0000-0000-0000-000000000000"
  }'
```

Responses:

- `201`: The newly created coupon uses with the selected columns.
- `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.
- `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

## Delete coupon uses

`DELETE /v1/coupon_uses`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/fr-FR/api-reference/filtering.md)). Without filters, this request deletes all coupon uses you have access to. Always filter on at least one column, e.g. `id=eq.{id}`.

```bash
curl -X DELETE "https://api.bookingmood.com/v1/coupon_uses?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: The deleted coupon uses with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`.
- `400`: The request is malformed, for example an unknown column or an invalid filter.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.

## Update coupon uses

`PATCH /v1/coupon_uses`

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/fr-FR/api-reference/filtering.md)). Without filters, this request updates all coupon uses you have access to. Always filter on at least one column, e.g. `id=eq.{id}`. The body holds the attributes to change.

```bash
curl -X PATCH "https://api.bookingmood.com/v1/coupon_uses?id=eq.00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

Responses:

- `200`: The updated coupon uses with the selected columns. `204` without a body when sending the header `Prefer: return=minimal`.
- `400`: The request is malformed, for example an unknown column, an invalid filter or an invalid body.
- `401`: The API key is missing or invalid.
- `403`: The API key has no permission for this change, for example when writing rows of another organization.
- `409`: The change conflicts with existing data, for example a duplicate key or a reference to a row that does not exist.

Errors have a JSON body with a `code`, `message`, `details` and `hint`. See the [introduction](https://www.bookingmood.com/fr-FR/api-reference.md) for more on errors. The full API is described by the OpenAPI spec at https://api.bookingmood.com/v1/openapi.json.
