Zum Hauptinhalt springen
GET
/
subscriptions
/
{subscriptionId}
/
entitlements
cURL
curl -X GET \
 /subscriptions/{subscriptionId}/entitlements \
 --header "Authorization: Bearer <token>"
{
  "data": [
    {
      "id": "<string>",
      "subscriptionItem": {
        "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
        "name": "Fitness M",
        "description": "Everything included",
        "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
        "status": "active",
        "subscriptionId": "<string>"
      },
      "feature": {
        "id": "feature-1",
        "name": "number of users",
        "description": "This feature allows you to manage the number of users in your account.",
        "status": "active",
        "type": "switch",
        "config": [
          {
            "value": "<string>",
            "label": "<string>"
          }
        ],
        "unit": "<string>"
      },
      "value": "true",
      "validFrom": "2023-11-07T05:31:56Z",
      "validUntil": "2023-11-07T05:31:56Z",
      "active": true,
      "status": "active"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 123,
      "itemsPerPage": 123,
      "currentPage": 123,
      "lastPage": 123,
      "pageTotalItems": 123
    }
  }
}

Autorisierungen

Authorization
string
header
erforderlich

Value for the Authorization header parameter.

Pfadparameter

subscriptionId
string
erforderlich

Subscription identifier

Abfrageparameter

status
enum<string>

Filter entitlements by status. Use this to retrieve only active entitlements or entitlements in a specific state.

Verfügbare Optionen:
active,
pending,
disabled,
expired
includeExpired
boolean
Standard:false

Include expired entitlements in the response. By default, expired entitlements are excluded.

page
integer
Standard:1

The collection page number

limit
integer
Standard:30

The number of items per page

Erforderlicher Bereich: 0 <= x <= 100

Antwort

Entitlement collection

data
object[]
meta
object