API Reference · Billing

Entitlements

Feature flags and quota entitlements computed from active subscriptions.

The entitlement object

Represents a entitlement entity in the rafiqPay system.

Field	Type & Flags	Description
featureKey	string	Feature identifier (e.g. "live_arabic_tutoring").
hasAccess	boolean	Whether the customer currently has access.

Example entitlement JSON

entitlement example payload

{
  "object": "list",
  "data": [
    {
      "featureKey": "live_arabic_tutoring",
      "hasAccess": true
    }
  ]
}

Endpoints & Operations

GET/v1/customers/:id/entitlementsProposed

Check a customer's entitlements

Proposed. Not built: there is no entitlements endpoint yet.

Request Example

GET /v1/customers/:id/entitlements

cURL · v1

curl -X GET "https://api.rafiqpay.net/v1/customers/:id/entitlements" \
  -H "Authorization: Bearer rp_test_sk_kanzu_9f8a7b6c5d4e3f2a"

Response (200 OK)

Response payload

{
  "object": "list",
  "data": [
    {
      "featureKey": "live_arabic_tutoring",
      "hasAccess": true
    }
  ],
  "hasMore": false,
  "nextCursor": null
}