v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB

Entitlements

Create an entitlement definition

Creates a new entitlement definition for the authenticated project.

post/entitlements

Request body

idstring required

Unique entitlement identifier.

descriptionstring nullable

Human-readable description of the entitlement.

product_idsstring[] nullable

List of product IDs to associate with this entitlement.

Example request

{
  "id": "premium",
  "description": "Premium access entitlement",
  "product_ids": [
    "premium_monthly",
    "premium_annual"
  ]
}

Response

Created entitlement definition.

object'entitlement' required

idstring required

Unique entitlement identifier.

urlstring required

Canonical API path.

descriptionstring nullable

Human-readable description of the entitlement.

product_idsstring[] nullable

List of product IDs associated with this entitlement.

created_atstring date-time required

Creation timestamp (ISO 8601 UTC).

updated_atstring date-time required

Last update timestamp (ISO 8601 UTC).

Example response

{
  "id": "premium",
  "url": "/v4/entitlements/premium",
  "description": "Premium access entitlement",
  "product_ids": [
    "premium_monthly",
    "premium_annual"
  ],
  "created_at": "2025-09-15T12:30:00Z",
  "updated_at": "2025-11-03T10:26:40Z"
}