---
title: Fetch Entitlements
slug: fetch-entitlements
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "11k3ze-s5T_2C-S6MHNux",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/entitlements",
    "servers": [
      {
        "url": "https://api.nue.io/entitlements",
        "description": "**Production Environment** - Live production server for all customer-facing operations. Use this for production integrations with real customer data and transactions."
      },
      {
        "url": "https://api.sandbox.nue.io/entitlements",
        "description": "**Sandbox Environment** - Safe testing environment with sample data for development and integration testing. No rate limits apply. Data is reset weekly. Perfect for prototyping and QA testing."
      }
    ],
    "name": "Fetch Entitlements",
    "description": "<p>Retrieve entitlement information for customers or by specific entitlement number. Entitlements represent what products and features customers are entitled to use, including usage limits and access controls.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "customerIds",
          "type": "string",
          "example": "[\"cust-12345\", \"cust-67890\"]",
          "description": "<p>A JSON-encoded array of customer IDs to fetch entitlements for. Cannot be used with entitlementNumber.</p>"
        },
        {
          "kind": "optional",
          "name": "entitlementNumber",
          "type": "string",
          "example": "ENT-001234",
          "description": "Specific entitlement number to retrieve. Cannot be used with customerIds."
        },
        {
          "kind": "optional",
          "name": "history",
          "type": "boolean",
          "description": "Whether to include historical versions of the entitlement. Only works with entitlementNumber."
        },
        {
          "kind": "optional",
          "name": "includes",
          "type": "string",
          "description": "<p>Comma-separated list of additional data to include. Options: product, pricetags</p>",
          "enum": [
            "product",
            "pricetags",
            "product,pricetags"
          ]
        },
        {
          "kind": "optional",
          "name": "status",
          "type": "string",
          "description": "Filter entitlements by status",
          "enum": [
            "active",
            "expired",
            "canceled"
          ]
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "ApiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successfully retrieved entitlements",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// Successfully retrieved entitlements\n{\n  \"status\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"entitlementNumber\": \"\",\n      \"name\": \"\",\n      \"status\": \"\",\n      \"customerId\": \"\",\n      \"productId\": \"\",\n      \"orderProductId\": \"\",\n      \"quantity\": 0,\n      \"usedQuantity\": 0,\n      \"startDate\": \"\",\n      \"endDate\": \"\",\n      \"entitlementVersion\": 0,\n      \"billingAccountId\": \"\",\n      \"createdDate\": \"\",\n      \"lastModifiedDate\": \"\",\n      \"product\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"sku\": \"\",\n        \"description\": \"\"\n      },\n      \"priceTags\": [\n        {\n          \"id\": \"\",\n          \"name\": \"\",\n          \"code\": \"\"\n        }\n      ]\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"\",\n      \"message\": \"\"\n    }\n  ]\n}"
          },
          {
            "label": "singleEntitlementByNumber",
            "code": "// Retrieve a specific entitlement by entitlement number\n{\n  \"status\": \"SUCCESS\",\n  \"data\": [\n    {\n      \"id\": \"ent-12345\",\n      \"entitlementNumber\": \"ENT-001234\",\n      \"name\": \"API Access Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-abcdef\",\n      \"orderProductId\": \"op-123456\",\n      \"quantity\": 1000,\n      \"usedQuantity\": 250,\n      \"startDate\": \"2024-01-01\",\n      \"endDate\": \"2024-12-31\",\n      \"entitlementVersion\": 1,\n      \"billingAccountId\": \"ba-999888\",\n      \"createdDate\": \"2024-01-01T00:00:00Z\",\n      \"lastModifiedDate\": \"2024-01-15T14:30:00Z\"\n    }\n  ],\n  \"warnings\": []\n}"
          },
          {
            "label": "entitlementsByCustomerIds",
            "code": "// Retrieve entitlements for multiple customers\n{\n  \"status\": \"PARTIAL_SUCCESS\",\n  \"data\": [\n    {\n      \"id\": \"ent-12345\",\n      \"entitlementNumber\": \"ENT-001234\",\n      \"name\": \"API Access Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-abcdef\",\n      \"quantity\": 1000,\n      \"usedQuantity\": 250,\n      \"startDate\": \"2024-01-01\",\n      \"endDate\": \"2024-12-31\"\n    },\n    {\n      \"id\": \"ent-67890\",\n      \"entitlementNumber\": \"ENT-001235\",\n      \"name\": \"Storage Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-ghijkl\",\n      \"quantity\": 500,\n      \"usedQuantity\": 120,\n      \"startDate\": \"2024-02-01\",\n      \"endDate\": \"2025-01-31\"\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"NOT_FOUND\",\n      \"message\": \"No entitlements found for customer ID cust-11111.\"\n    }\n  ]\n}"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "string<SUCCESS | PARTIAL_SUCCESS | FAILURE>",
                "description": "Status of the request",
                "enum": [
                  "SUCCESS",
                  "PARTIAL_SUCCESS",
                  "FAILURE"
                ]
              },
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "Array of entitlements",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "description": "Unique identifier for the entitlement"
                  },
                  {
                    "name": "entitlementNumber",
                    "kind": "optional",
                    "type": "string",
                    "description": "Entitlement number identifier"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "Entitlement name"
                  },
                  {
                    "name": "status",
                    "kind": "optional",
                    "type": "string",
                    "description": "Current status of the entitlement"
                  },
                  {
                    "name": "customerId",
                    "kind": "optional",
                    "type": "string",
                    "description": "ID of the customer who owns this entitlement"
                  },
                  {
                    "name": "productId",
                    "kind": "optional",
                    "type": "string",
                    "description": "ID of the product this entitlement represents"
                  },
                  {
                    "name": "orderProductId",
                    "kind": "optional",
                    "type": "string",
                    "description": "ID of the order product that created this entitlement"
                  },
                  {
                    "name": "quantity",
                    "kind": "optional",
                    "type": "number",
                    "description": "Entitled quantity"
                  },
                  {
                    "name": "usedQuantity",
                    "kind": "optional",
                    "type": "number",
                    "description": "Currently used quantity"
                  },
                  {
                    "name": "startDate",
                    "kind": "optional",
                    "type": "string<date>",
                    "description": "Start date of the entitlement",
                    "format": "date"
                  },
                  {
                    "name": "endDate",
                    "kind": "optional",
                    "type": "string<date>",
                    "description": "End date of the entitlement",
                    "format": "date"
                  },
                  {
                    "name": "entitlementVersion",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Version number of the entitlement (for history tracking)</p>"
                  },
                  {
                    "name": "billingAccountId",
                    "kind": "optional",
                    "type": "string",
                    "description": "ID of the billing account associated with this entitlement"
                  },
                  {
                    "name": "createdDate",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "When the entitlement was created",
                    "format": "date-time"
                  },
                  {
                    "name": "lastModifiedDate",
                    "kind": "optional",
                    "type": "string<date-time>",
                    "description": "When the entitlement was last modified",
                    "format": "date-time"
                  },
                  {
                    "name": "product",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Product details (included when includes=product)</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "sku",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "description",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  },
                  {
                    "name": "priceTags",
                    "kind": "optional",
                    "type": "array",
                    "description": "<p>Price tags applied to this entitlement (included when includes=pricetags)</p>",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      },
                      {
                        "name": "code",
                        "kind": "optional",
                        "type": "string",
                        "description": ""
                      }
                    ]
                  }
                ]
              },
              {
                "name": "warnings",
                "kind": "optional",
                "type": "array",
                "description": "Any warnings generated during processing",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "code",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  },
                  {
                    "name": "message",
                    "kind": "optional",
                    "type": "string",
                    "description": ""
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "207",
        "description": "<p>Partial Success - Some customer IDs found, others not found</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "required",
                "type": "string<FAILURE>",
                "description": "Status of the request",
                "enum": [
                  "FAILURE"
                ]
              },
              {
                "name": "errorType",
                "kind": "optional",
                "type": "string<NOT_FOUND | INVALID_PARAMETER | MISSING_PARAMETER | INVALID_ARGUMENT | AUTHENTICATION_ERROR>",
                "description": "Type of error that occurred",
                "enum": [
                  "NOT_FOUND",
                  "INVALID_PARAMETER",
                  "MISSING_PARAMETER",
                  "INVALID_ARGUMENT",
                  "AUTHENTICATION_ERROR"
                ]
              },
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string<MISSING_DETAILS_FETCH_PARAMETER | MISSING_FETCH_PARAMETER | INVALID_CUSTOMER_IDS_FORMAT | INVALID_PARAMETER_COMBINATION | ORDER_UNKNOWN_FIELD | CUSTOMER_NOT_FOUND | MISSING_AUTH_METHOD | INSUFFICIENT_PERMISSIONS | INVALID_JSON>",
                "description": "Specific error code for the failure",
                "enum": [
                  "MISSING_DETAILS_FETCH_PARAMETER",
                  "MISSING_FETCH_PARAMETER",
                  "INVALID_CUSTOMER_IDS_FORMAT",
                  "INVALID_PARAMETER_COMBINATION",
                  "ORDER_UNKNOWN_FIELD",
                  "CUSTOMER_NOT_FOUND",
                  "MISSING_AUTH_METHOD",
                  "INSUFFICIENT_PERMISSIONS",
                  "INVALID_JSON"
                ]
              },
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable error message</p>"
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "<p>Bad Request - The request was malformed or contained invalid parameters</p>",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n  \"status\": \"\",\n  \"errorType\": \"\",\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
          },
          {
            "label": "missingParameters",
            "code": "// Missing required parameters\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"MISSING_PARAMETER\",\n  \"errorCode\": \"MISSING_FETCH_PARAMETER\",\n  \"message\": \"Either customerIds or entitlementNumber must be provided.\"\n}"
          },
          {
            "label": "invalidCustomerIds",
            "code": "// Invalid customer IDs format\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"INVALID_PARAMETER\",\n  \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n  \"message\": \"Parameter customerIds must be a valid JSON array of non-empty strings.\"\n}"
          },
          {
            "label": "invalidParameterCombination",
            "code": "// Invalid parameter combination\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"INVALID_PARAMETER\",\n  \"errorCode\": \"INVALID_PARAMETER_COMBINATION\",\n  \"message\": \"The customerIds and entitlementNumber parameters cannot be used together.\"\n}"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "status",
                "kind": "required",
                "type": "string<FAILURE>",
                "description": "Status of the request",
                "enum": [
                  "FAILURE"
                ]
              },
              {
                "name": "errorType",
                "kind": "optional",
                "type": "string<NOT_FOUND | INVALID_PARAMETER | MISSING_PARAMETER | INVALID_ARGUMENT | AUTHENTICATION_ERROR>",
                "description": "Type of error that occurred",
                "enum": [
                  "NOT_FOUND",
                  "INVALID_PARAMETER",
                  "MISSING_PARAMETER",
                  "INVALID_ARGUMENT",
                  "AUTHENTICATION_ERROR"
                ]
              },
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string<MISSING_DETAILS_FETCH_PARAMETER | MISSING_FETCH_PARAMETER | INVALID_CUSTOMER_IDS_FORMAT | INVALID_PARAMETER_COMBINATION | ORDER_UNKNOWN_FIELD | CUSTOMER_NOT_FOUND | MISSING_AUTH_METHOD | INSUFFICIENT_PERMISSIONS | INVALID_JSON>",
                "description": "Specific error code for the failure",
                "enum": [
                  "MISSING_DETAILS_FETCH_PARAMETER",
                  "MISSING_FETCH_PARAMETER",
                  "INVALID_CUSTOMER_IDS_FORMAT",
                  "INVALID_PARAMETER_COMBINATION",
                  "ORDER_UNKNOWN_FIELD",
                  "CUSTOMER_NOT_FOUND",
                  "MISSING_AUTH_METHOD",
                  "INSUFFICIENT_PERMISSIONS",
                  "INVALID_JSON"
                ]
              },
              {
                "name": "message",
                "kind": "required",
                "type": "string",
                "description": "<p>Human-readable error message</p>"
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized - Authentication information is missing or invalid</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>Authentication failed — returned with HTTP 401. Two variants occur: a missing key is rejected by the gateway with {status: \"FAILURE\", errorCode, errorType, message}; an invalid key is rejected by the service with {status: 401, error, message}.</p>",
            "customType": "UnauthorizedError",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "",
                "description": "<p>HTTP status code (e.g. 401) or the string \"FAILURE\" for gateway-level rejections.</p>"
              },
              {
                "name": "error",
                "kind": "optional",
                "type": "string",
                "description": "<p>Error reason phrase (invalid-key variant).</p>"
              },
              {
                "name": "errorCode",
                "kind": "optional",
                "type": "string",
                "description": "<p>Machine-readable error code, e.g. MISSING_AUTH_METHOD (missing-key variant).</p>"
              },
              {
                "name": "errorType",
                "kind": "optional",
                "type": "string",
                "description": "<p>Error category, e.g. AUTHENTICATION_ERROR (missing-key variant).</p>"
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>Human-readable error message.</p>"
              }
            ],
            "modelRef": "#/components/schemas/UnauthorizedError",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "404",
        "description": "<p>Not Found - The requested resource was not found</p>",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// Not Found - The requested resource was not found\n{\n  \"status\": 0,\n  \"error\": \"\",\n  \"message\": \"\"\n}"
          },
          {
            "label": "resourceNotFound",
            "code": "// Resource not found\n{\n  \"timestamp\": \"2024-01-15T14:30:00Z\",\n  \"path\": \"/customers\",\n  \"status\": 404,\n  \"error\": \"Not Found\",\n  \"requestId\": \"req-12345\"\n}"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "<p>The requested resource was not found — returned with HTTP 404.</p>",
            "customType": "NotFoundError",
            "schema": [
              {
                "name": "status",
                "kind": "optional",
                "type": "integer",
                "description": "HTTP status code."
              },
              {
                "name": "error",
                "kind": "optional",
                "type": "string",
                "description": "Error reason phrase."
              },
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>Human-readable error message.</p>"
              }
            ],
            "modelRef": "#/components/schemas/NotFoundError",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "waSCeHDhQzB0NKLgTGNzs",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/entitlements \\\n     --header 'accept: application/json'"
        },
        {
          "id": "HYgX48hqUrhmWMguqQYz2",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/entitlements\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "4tgbXXSNgkwiaTpm89M5l",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/entitlements\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "azdOjlLXcSOgQw8dysh1f",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/entitlements\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "waSCeHDhQzB0NKLgTGNzs"
    },
    "results": {
      "languages": [
        {
          "id": "c3n0-D5iBbqkofw0mrtBe",
          "language": "200",
          "code": "// Successfully retrieved entitlements\n{\n  \"status\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"entitlementNumber\": \"\",\n      \"name\": \"\",\n      \"status\": \"\",\n      \"customerId\": \"\",\n      \"productId\": \"\",\n      \"orderProductId\": \"\",\n      \"quantity\": 0,\n      \"usedQuantity\": 0,\n      \"startDate\": \"\",\n      \"endDate\": \"\",\n      \"entitlementVersion\": 0,\n      \"billingAccountId\": \"\",\n      \"createdDate\": \"\",\n      \"lastModifiedDate\": \"\",\n      \"product\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"sku\": \"\",\n        \"description\": \"\"\n      },\n      \"priceTags\": [\n        {\n          \"id\": \"\",\n          \"name\": \"\",\n          \"code\": \"\"\n        }\n      ]\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"\",\n      \"message\": \"\"\n    }\n  ]\n}",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// Successfully retrieved entitlements\n{\n  \"status\": \"\",\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"entitlementNumber\": \"\",\n      \"name\": \"\",\n      \"status\": \"\",\n      \"customerId\": \"\",\n      \"productId\": \"\",\n      \"orderProductId\": \"\",\n      \"quantity\": 0,\n      \"usedQuantity\": 0,\n      \"startDate\": \"\",\n      \"endDate\": \"\",\n      \"entitlementVersion\": 0,\n      \"billingAccountId\": \"\",\n      \"createdDate\": \"\",\n      \"lastModifiedDate\": \"\",\n      \"product\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"sku\": \"\",\n        \"description\": \"\"\n      },\n      \"priceTags\": [\n        {\n          \"id\": \"\",\n          \"name\": \"\",\n          \"code\": \"\"\n        }\n      ]\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"\",\n      \"message\": \"\"\n    }\n  ]\n}"
            },
            {
              "label": "singleEntitlementByNumber",
              "code": "// Retrieve a specific entitlement by entitlement number\n{\n  \"status\": \"SUCCESS\",\n  \"data\": [\n    {\n      \"id\": \"ent-12345\",\n      \"entitlementNumber\": \"ENT-001234\",\n      \"name\": \"API Access Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-abcdef\",\n      \"orderProductId\": \"op-123456\",\n      \"quantity\": 1000,\n      \"usedQuantity\": 250,\n      \"startDate\": \"2024-01-01\",\n      \"endDate\": \"2024-12-31\",\n      \"entitlementVersion\": 1,\n      \"billingAccountId\": \"ba-999888\",\n      \"createdDate\": \"2024-01-01T00:00:00Z\",\n      \"lastModifiedDate\": \"2024-01-15T14:30:00Z\"\n    }\n  ],\n  \"warnings\": []\n}"
            },
            {
              "label": "entitlementsByCustomerIds",
              "code": "// Retrieve entitlements for multiple customers\n{\n  \"status\": \"PARTIAL_SUCCESS\",\n  \"data\": [\n    {\n      \"id\": \"ent-12345\",\n      \"entitlementNumber\": \"ENT-001234\",\n      \"name\": \"API Access Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-abcdef\",\n      \"quantity\": 1000,\n      \"usedQuantity\": 250,\n      \"startDate\": \"2024-01-01\",\n      \"endDate\": \"2024-12-31\"\n    },\n    {\n      \"id\": \"ent-67890\",\n      \"entitlementNumber\": \"ENT-001235\",\n      \"name\": \"Storage Entitlement\",\n      \"status\": \"Active\",\n      \"customerId\": \"cust-67890\",\n      \"productId\": \"prod-ghijkl\",\n      \"quantity\": 500,\n      \"usedQuantity\": 120,\n      \"startDate\": \"2024-02-01\",\n      \"endDate\": \"2025-01-31\"\n    }\n  ],\n  \"warnings\": [\n    {\n      \"code\": \"NOT_FOUND\",\n      \"message\": \"No entitlements found for customer ID cust-11111.\"\n    }\n  ]\n}"
            }
          ]
        },
        {
          "id": "0NnJuZh2LVWOh-GGGrekM",
          "language": "207",
          "code": "// Partial Success - Some customer IDs found, others not found\n{\n  \"status\": \"\",\n  \"errorType\": \"\",\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
        },
        {
          "id": "NHHk7hq0bEk8AS-Roxoon",
          "language": "400",
          "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n  \"status\": \"\",\n  \"errorType\": \"\",\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n  \"status\": \"\",\n  \"errorType\": \"\",\n  \"errorCode\": \"\",\n  \"message\": \"\"\n}"
            },
            {
              "label": "missingParameters",
              "code": "// Missing required parameters\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"MISSING_PARAMETER\",\n  \"errorCode\": \"MISSING_FETCH_PARAMETER\",\n  \"message\": \"Either customerIds or entitlementNumber must be provided.\"\n}"
            },
            {
              "label": "invalidCustomerIds",
              "code": "// Invalid customer IDs format\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"INVALID_PARAMETER\",\n  \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n  \"message\": \"Parameter customerIds must be a valid JSON array of non-empty strings.\"\n}"
            },
            {
              "label": "invalidParameterCombination",
              "code": "// Invalid parameter combination\n{\n  \"status\": \"FAILURE\",\n  \"errorType\": \"INVALID_PARAMETER\",\n  \"errorCode\": \"INVALID_PARAMETER_COMBINATION\",\n  \"message\": \"The customerIds and entitlementNumber parameters cannot be used together.\"\n}"
            }
          ]
        },
        {
          "id": "8Qi9cgn0NjLTPK4CiqlIz",
          "language": "401",
          "code": "// Unauthorized - Authentication information is missing or invalid\n{\n  \"status\": \"\",\n  \"error\": \"\",\n  \"errorCode\": \"\",\n  \"errorType\": \"\",\n  \"message\": \"\"\n}"
        },
        {
          "id": "BRY9QYg8QpE6jjrQLdcri",
          "language": "404",
          "code": "// Not Found - The requested resource was not found\n{\n  \"status\": 0,\n  \"error\": \"\",\n  \"message\": \"\"\n}",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// Not Found - The requested resource was not found\n{\n  \"status\": 0,\n  \"error\": \"\",\n  \"message\": \"\"\n}"
            },
            {
              "label": "resourceNotFound",
              "code": "// Resource not found\n{\n  \"timestamp\": \"2024-01-15T14:30:00Z\",\n  \"path\": \"/customers\",\n  \"status\": 404,\n  \"error\": \"Not Found\",\n  \"requestId\": \"req-12345\"\n}"
            }
          ]
        }
      ],
      "selectedLanguageId": "c3n0-D5iBbqkofw0mrtBe"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}