Issue Entitlement

Issue a new entitlement to a customer, granting them access to a specific feature. The feature must exist and belong to the same merchant as the customer.

POST /v1/entitlements

cURL

booleanEntitlement

curl --request POST \
  --url https://api.paygentic.io/v1/entitlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "cus_q3r4s5t6u7v8w9x0",
  "featureId": "feat_a1b2c3d4e5f6g7h8",
  "template": {
    "type": "boolean"
  }
}
'

201

{
  "object": "entitlement",
  "id": "<string>",
  "customerId": "<string>",
  "featureId": "<string>",
  "status": "active",
  "activeFrom": "2023-11-07T05:31:56Z",
  "config": {},
  "subscriptionId": "<string>",
  "activeTo": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

API key authentication

Body

application/json

customerId · string · required

The customer to issue the entitlement to.

Pattern: ^cus_[a-zA-Z0-9]+$

featureId · string · required

The feature to grant access to.

Pattern: ^feat_[a-zA-Z0-9]+$

template · object · required

The template defining the entitlement type and configuration.

Option 1

Option 2

Option 3

Show child attributes

activeFrom · string<date-time>

When the entitlement becomes active. Defaults to now.

activeTo · string<date-time> | null

When the entitlement expires. Null means no expiration.

subscriptionId · string | null

Optional subscription ID to associate with this entitlement.

metadata · object

Additional metadata for the entitlement.

Show child attributes

Response

201

application/json

Entitlement successfully issued.

object · enum<string> · default: entitlement · required

Available options: entitlement

id · string · required

Unique identifier for the entitlement.

Pattern: ^ent_[a-zA-Z0-9]+$

customerId · string · required

Unique identifier for a customer

Pattern: ^cus_[a-zA-Z0-9]+$

featureId · string · required

The feature this entitlement grants access to.

Pattern: ^feat_[a-zA-Z0-9]+$

status · enum<string> · required

Current status of the entitlement.

Available options: active, canceled, expired

activeFrom · string<date-time> · required

When the entitlement becomes active.

config · object · required

Configuration values for static features.

subscriptionId · string | null

The subscription this entitlement is associated with, if any.

activeTo · string<date-time> | null

When the entitlement expires. Null means no expiration.

metadata · object

Additional metadata for the entitlement.

Show child attributes