---
title: "Entitlement"
permalink: "/docs/api-v2/entitlement"
original_source: "openapi-spec/api-v2.yaml"
---

> **AI agents:** This is the Markdown version of a RevenueCat documentation page. For the complete documentation index, see [llms.txt](https://www.revenuecat.com/docs/llms.txt).

# Entitlement

## Entitlement

Operations about entitlements.

### Get an entitlement

`GET /projects/{project_id}/entitlements/{entitlement_id}`

Operation ID: `get-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |
| `expand` | query | no | Specifies which fields in the response should be expanded. Accepted values are: `product` (requires `project_configuration:products:read` permission). |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Update an entitlement

`POST /projects/{project_id}/entitlements/{entitlement_id}`

Operation ID: `update-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `display_name` | string | yes | The display name of the entitlement |

**Responses**

- `200` — Success. The entitlement was updated
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Delete an entitlement

`DELETE /projects/{project_id}/entitlements/{entitlement_id}`

Operation ID: `delete-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | The type of the deleted object One of: `app`, `chart_annotation`, `customer`, `discount`, `entitlement`, `experiment`, `offering`, `package`, `paywall`, `product`, `virtual_currency`, `webhook_integration` |
| `id` | string | yes | The ID of the deleted object |
| `deleted_at` | integer | yes | The date when the object was deleted in ms since epoch |

### Get a list of entitlements

`GET /projects/{project_id}/entitlements`

Operation ID: `list-entitlements`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `starting_after` | query | no | Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| `limit` | query | no | Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |
| `expand` | query | no | Specifies which fields in the response should be expanded. Accepted values are: `items.product` (requires `project_configuration:products:read` permission). |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Entitlement | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the project's entitlements. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

</details>
</details>
### Create an entitlement

`POST /projects/{project_id}/entitlements`

Operation ID: `create-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `lookup_key` | string | yes | The identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |

**Responses**

- `201` — Success. The entitlement was created
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `201` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Get a list of products attached to a given entitlement

`GET /projects/{project_id}/entitlements/{entitlement_id}/products`

Operation ID: `get-products-from-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |
| `starting_after` | query | no | Pagination cursor. Pass the id of the last item from the previous page to fetch the next page; omit for the first page. |
| `limit` | query | no | Maximum number of items to return per page. Values below 1 or above 100 are clamped to that range rather than rejected. |

**Responses**

- `200` — Success
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

<details><summary><code>subscription</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `duration` | string | yes | The duration of the subscription in ISO-8601 standard |
| `grace_period_duration` | string | yes | The duration of the subscription's grace period in ISO-8601 standard |
| `trial_duration` | string | yes | The duration of the subscription's trial period in ISO-8601 standard |

</details>

<details><summary><code>one_time</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `is_consumable` | boolean | yes | Indicates whether the product is consumable or not. |

</details>

<details><summary><code>indicative_price</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `indicative_price` |
| `currency` | Currency | yes | ISO 4217 currency code One of: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTC`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLF`, `CLP`, `CNH`, `CNY`, `COP`, `CRC`, `CUC`, `CUP`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ERN`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GGP`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HRK`, `HTG`, `HUF`, `IDR`, `ILS`, `IMP`, `INR`, `IQD`, `IRR`, `ISK`, `JEP`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KPW`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MRU`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SDG`, `SEK`, `SGD`, `SHP`, `SLL`, `SOS`, `SRD`, `SSP`, `STD`, `STN`, `SVC`, `SYP`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VEF`, `VES`, `VND`, `VUV`, `WST`, `XAF`, `XAG`, `XAU`, `XCD`, `XDR`, `XOF`, `XPD`, `XPF`, `XPT`, `YER`, `ZAR`, `ZMW`, `ZWL` |
| `country` | Country | yes | The country that the object is associated with, in ISO alpha 2 code One of: `null`, `AF`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`, `AW`, `AU`, `AT`, `AZ`, `BS`, `BH`, `BD`, `BB`, `BY`, `BE`, `BZ`, `BJ`, `BM`, `BT`, `BO`, `BQ`, `BA`, `BW`, `BV`, `BR`, `IO`, `BN`, `BG`, `BF`, `BI`, `CV`, `KH`, `CM`, `CA`, `KY`, `CF`, `TD`, `CL`, `CN`, `CX`, `CC`, `CO`, `KM`, `CD`, `CG`, `CK`, `CR`, `HR`, `CU`, `CW`, `CY`, `CZ`, `CI`, `DK`, `DJ`, `DM`, `DO`, `EC`, `EG`, `SV`, `GQ`, `ER`, `EE`, `SZ`, `ET`, `FK`, `FO`, `FJ`, `FI`, `FR`, `GF`, `PF`, `TF`, `GA`, `GM`, `GE`, `DE`, `GH`, `GI`, `GR`, `GL`, `GD`, `GP`, `GU`, `GT`, `GG`, `GN`, `GW`, `GY`, `HT`, `HM`, `VA`, `HN`, `HK`, `HU`, `IS`, `IN`, `ID`, `IR`, `IQ`, `IE`, `IM`, `IL`, `IT`, `JM`, `JP`, `JE`, `JO`, `KZ`, `KE`, `KI`, `KP`, `KR`, `KW`, `KG`, `LA`, `LV`, `LB`, `LS`, `LR`, `LY`, `LI`, `LT`, `LU`, `MO`, `MG`, `MW`, `MY`, `MV`, `ML`, `MT`, `MH`, `MQ`, `MR`, `MU`, `YT`, `MX`, `FM`, `MD`, `MC`, `MN`, `ME`, `MS`, `MA`, `MZ`, `MM`, `NA`, `NR`, `NP`, `NL`, `NC`, `NZ`, `NI`, `NE`, `NG`, `NU`, `NF`, `MP`, `NO`, `OM`, `PK`, `PW`, `PS`, `PA`, `PG`, `PY`, `PE`, `PH`, `PN`, `PL`, `PT`, `PR`, `QA`, `MK`, `RO`, `RU`, `RW`, `RE`, `BL`, `SH`, `KN`, `LC`, `MF`, `PM`, `VC`, `WS`, `SM`, `ST`, `SA`, `SN`, `RS`, `SC`, `SL`, `SG`, `SX`, `SK`, `SI`, `SB`, `SO`, `ZA`, `GS`, `SS`, `ES`, `LK`, `SD`, `SR`, `SJ`, `SE`, `CH`, `SY`, `TW`, `TJ`, `TZ`, `TH`, `TL`, `TG`, `TK`, `TO`, `TT`, `TN`, `TR`, `TM`, `TC`, `TV`, `UG`, `UA`, `AE`, `GB`, `UM`, `US`, `UY`, `UZ`, `VU`, `VE`, `VN`, `VG`, `VI`, `WF`, `EH`, `YE`, `ZM`, `ZW`, `AX` |
| `amount_micros` | AmountMicros | yes | The price in micros. For example, USD 1 would be represented as 1000000 |

</details>
</details>
### Archive an entitlement

`POST /projects/{project_id}/entitlements/{entitlement_id}/actions/archive`

Operation ID: `archive-entitlement`

Archives an entitlement (makes it inactive).
 This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Responses**

- `200` — Success. The entitlement was archived
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Unarchive an entitlement

`POST /projects/{project_id}/entitlements/{entitlement_id}/actions/unarchive`

Operation ID: `unarchive-entitlement`

Unarchives an entitlement (makes it active).
 This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Responses**

- `200` — Success. The entitlement was unarchived
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Attach a set of products to an entitlement

`POST /projects/{project_id}/entitlements/{entitlement_id}/actions/attach_products`

Operation ID: `attach-products-to-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `product_ids` | array of string | yes | IDs of the products to be attached to the entitlement. |

**Responses**

- `200` — Success. The products were attached to the entitlement
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>
### Detach a set of product from an entitlement

`POST /projects/{project_id}/entitlements/{entitlement_id}/actions/detach_products`

Operation ID: `detach-products-from-entitlement`

This endpoint requires the following permission(s): <code>project_configuration:entitlements:read_write</code>. This endpoint belongs to the <strong>Project Configuration</strong> domain, which has a default rate limit of <strong>60 requests per minute</strong>.

**Parameters**

| Name | In | Required | Description |
| --- | --- | --- | --- |
| `project_id` | path | yes | ID of the project |
| `entitlement_id` | path | yes | ID of the entitlement |

**Request body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `product_ids` | array of string | yes | IDs of the products to be detached from the entitlement. |

**Responses**

- `200` — Success. The products were detached from the entitlement
- `400` — Bad request
- `401` — Unauthorized
- `403` — Access denied
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity
- `423` — Locked
- `429` — The request could not be completed because the rate limiting domain for this endpoint is currently at its limit for this project.
- `500` — Internal server error
- `503` — Internal server error

**Response `200` body**

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the entitlement is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. One of: `entitlement` |
| `project_id` | string | yes | ID of the project to which the entitlement belongs |
| `id` | string | yes | The id of the entitlement |
| `lookup_key` | string | yes | A custom identifier of the entitlement |
| `display_name` | string | yes | The display name of the entitlement |
| `created_at` | integer | yes | The date when the entitlement was created in ms since epoch |
| `products` | object | no | List of products attached to the entitlement |

<details><summary><code>products</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `list` |
| `items` | array of Product | yes | Details about each object. |
| `next_page` | string | yes | URL to access the next page of the Entitlement's products. If not present / null, there is no next page |
| `url` | string | yes | The URL where this list can be accessed. |

<details><summary><code>items</code></summary>

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `state` | string | yes | Whether the product is active or inactive (archived). One of: `active`, `inactive` |
| `object` | string | yes | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. One of: `product` |
| `id` | string | yes | The id of the product |
| `store_identifier` | string | yes | The store product identifier |
| `type` | ProductType | yes | One of: `subscription`, `one_time`, `consumable`, `non_consumable`, `non_renewing_subscription` |
| `subscription` | SubscriptionProduct | no |  |
| `one_time` | OneTimeProduct | no |  |
| `created_at` | integer | yes | The date when the product was created in ms since epoch |
| `app_id` | string | yes | The id of the app |
| `app` | App | no |  |
| `indicative_price` | IndicativePrice | no | An indicative price for a product, in the default currency/country (USD / US). Uses the same price source as the get-offering-prices endpoint. |
| `display_name` | string | yes | The display name of the product |

</details>
</details>