Skip to main content
PATCH
Update an entitlement definition (partial)

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

entitlement_id
string
required

Entitlement identifier.

Body

application/json
description
string | null

Human-readable description of the entitlement.

Example:

"Updated premium access entitlement"

product_ids
string[] | null

List of product IDs to associate with this entitlement.

Example:

Response

Updated entitlement definition.

object
enum<string>
required
Available options:
entitlement
id
string
required

Unique entitlement identifier.

Example:

"premium"

url
string
required

Canonical API path.

Example:

"/v4/entitlements/premium"

created_at
string<date-time>
required

Creation timestamp (ISO 8601 UTC).

Example:

"2025-09-15T12:30:00Z"

updated_at
string<date-time>
required

Last update timestamp (ISO 8601 UTC).

Example:

"2025-11-03T10:26:40Z"

description
string | null

Human-readable description of the entitlement.

Example:

"Premium access entitlement"

product_ids
string[] | null

List of product IDs associated with this entitlement.

Example: