Retrieve all entitlements for a customer, optionally filtered by feature or product.
List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: "entitlement" instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call.
For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).
The Paygentic customer id to retrieve entitlements for. Supply exactly one of customerId or externalCustomerId. When combined with merchantId, the customer must belong to that merchant or the request resolves to not found.
Unique identifier for a customer
Pattern: ^cus_[a-zA-Z0-9]+$
externalCustomerId
string
The merchant's own external customer reference (Customer.externalId, exact match), used to retrieve entitlements without first resolving it to a cus_ id. Matches the externalId filter on GET /v1/customers (plain string, exact match — no pattern constraint, so any stored externalId is addressable). Supply exactly one of customerId or externalCustomerId. externalId is unique only within a merchant, so an effective merchant scope is required: either pass merchantId, or authenticate with a single-merchant API key. With no resolvable merchant scope the request is rejected.
Required string length: 1 - 255
merchantId
string
Optional merchant scope. With externalCustomerId it selects the merchant the external id is resolved within (required for the platform key, which has no single merchant). With customerId it acts as a tenant guard — the resolved customer must belong to this merchant, otherwise the request resolves to not found. A passed merchantId is only a filter and never grants access the caller does not already hold; authorization is always evaluated against the resolved customer's merchant.
Unique identifier for an organization
Pattern: ^org_[a-zA-Z0-9]+$
featureKey
string
Filter results to a specific feature by its key. When specified, productId is also required. Use this to check access to a single feature.
productId
string
Filter results to entitlements for a specific product. Required when featureKey is specified since feature keys are scoped to products.
Unique identifier for a product
Pattern: ^prod_[a-zA-Z0-9]+$
subscriptionId
string
Filter results to entitlements for a specific subscription.
Unique identifier for a subscription
Pattern: ^sub_[a-zA-Z0-9]+$
limit
integer
default:10
Maximum number of entitlements to return per page. Use with offset for pagination.
Required range: 1 <= x <= 100
offset
integer
default:0
Number of entitlements to skip. Use with limit for pagination through large result sets.
Required range: x >= 0
at
string<date-time>
Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.
Response
Successfully retrieved the list of entitlements for the customer.
object
enum<string>
default:list
required
Available options:
list
data
object[]
required
Array of entitlement list items. The shape of each item varies by featureType.
An entitlement as returned by the list endpoint. The shape varies by featureType. Uses entitlementId (not id) for backwards compatibility with the original list contract.
Option 1
Option 2
Option 3
Show child attributes
pagination
object
required
Offset-based pagination response.
Show child attributes
stale
object
Present only when the database can't be reached, or the list takes more than a second to compute. The response is then the last result for this same request in the past hour, computed at computedAt.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Paygentic","colors":{"primary":"#013F70","light":"#E0B1F7","dark":"#FF6F57"},"logo":{"light":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37","dark":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-dark.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=e472e905a55866be14a5e51b15f16db6"},"favicon":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/favicon.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=a93d7819e80f48ee401156e695125f09","navbar":{"links":[{"href":"mailto:support@paygentic.io","label":"Support"}]},"fonts":{"heading":{"family":"Funnel Display"},"body":{"family":"Host Grotesk"}},"integrations":{"posthog":{"apiKey":"phc_DYYQW9UMuySBrmREkYbwieAfTzyvSpOJVFm1v9DQzyh","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paygentic","hasAudioNarration":false,"actualSubdomain":"paygentic","customDomains":["docs.paygentic.io"],"gitSource":{"type":"github","owner":"paygentic","repo":"paygentic","deployBranch":"main","contentDirectory":"projects/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b027ed334aba046b8ae3628","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":161},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"Platform","count":29},{"language":"default","tag":"Subscriptions","count":15},{"language":"default","tag":"Sources","count":14},{"language":"default","tag":"Invoices V2","count":12},{"language":"default","tag":"Billing","count":10},{"language":"default","tag":"Pricing","count":10},{"language":"default","tag":"Billing Schedules","count":9},{"language":"default","tag":"Orders","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/entitlements/list-entitlements","slug":"/api-reference/entitlements/list-entitlements","pageMetadata":{"title":"List Entitlements","description":"Retrieve all entitlements for a customer, optionally filtered by feature or product.\n\nList items identify the entitlement with `entitlementId` (the original list contract). The get-by-id endpoint (`GET /v1/entitlements/{entitlementId}`) returns the same object but with a top-level `id` and `object: \"entitlement\"` instead — so use `item.entitlementId`, not `item.id`, when chaining a list result into a get-by-id call.\n\nFor metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to `limit` items per page).","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/entitlements/list-entitlements","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve all entitlements for a customer, optionally filtered by feature or product.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"List items identify the entitlement with \", _jsx(_components.code, {\n children: \"entitlementId\"\n }), \" (the original list contract). The get-by-id endpoint (\", _jsx(_components.code, {\n children: \"GET /v1/entitlements/{entitlementId}\"\n }), \") returns the same object but with a top-level \", _jsx(_components.code, {\n children: \"id\"\n }), \" and \", _jsx(_components.code, {\n children: \"object: \\\"entitlement\\\"\"\n }), \" instead — so use \", _jsx(_components.code, {\n children: \"item.entitlementId\"\n }), \", not \", _jsx(_components.code, {\n children: \"item.id\"\n }), \", when chaining a list result into a get-by-id call.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to \", _jsx(_components.code, {\n children: \"limit\"\n }), \" items per page).\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Entitlements","description":"Retrieve all entitlements for a customer, optionally filtered by feature or product.\n\nList items identify the entitlement with `entitlementId` (the original list contract). The get-by-id endpoint (`GET /v1/entitlements/{entitlementId}`) returns the same object but with a top-level `id` and `object: \"entitlement\"` instead — so use `item.entitlementId`, not `item.id`, when chaining a list result into a get-by-id call.\n\nFor metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to `limit` items per page).","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/entitlements/list-entitlements","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Entitlements"],"summary":"List Entitlements","description":"Retrieve all entitlements for a customer, optionally filtered by feature or product.\n\nList items identify the entitlement with `entitlementId` (the original list contract). The get-by-id endpoint (`GET /v1/entitlements/{entitlementId}`) returns the same object but with a top-level `id` and `object: \"entitlement\"` instead — so use `item.entitlementId`, not `item.id`, when chaining a list result into a get-by-id call.\n\nFor metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to `limit` items per page).","operationId":"listEntitlements","parameters":["ec0a5f67-67f9-4223-9b61-c84134dace5f","d8713a11-0637-4288-a07b-003540fd0520","12cd1be1-3a26-4ec1-a12f-f3769a21d287","5838d2b3-d797-44bb-829d-39080aad6ce7","43ee1859-816f-40b2-95a4-94195a08d1b5","f43bba38-dd71-409f-91a4-24266d798ca2","902326ae-4b54-405c-b1e7-97f4bbd6aa12","8c2667f3-a3aa-46b0-93fa-3226180b7822","91ab4e1d-f0af-4c57-9c83-c1a1c225b94a"],"responses":{"200":"11906286-c19b-4fc0-82b4-3f693f279838","400":"35790c52-b06f-4823-b204-7d06057dff24","403":"284e6466-3845-405a-aebc-7e66cf8100e7","404":"14751237-fdff-466b-bca9-003e8687e757","500":"881bf2f4-fca1-4bf4-a2cf-66218ba4f82a"},"x-permission":"entitlements:read","method":"get","type":"path","servers":["7498f67e-c06f-4d11-9a4e-7c43f0f53b26","d0f74462-aeec-4209-82f4-dbb60498c1a2"],"security":["341ede1c-db03-4e32-b951-0c478552f430"],"path":"/v1/entitlements","baseUrlOptions":["https://api.paygentic.io","https://api.sandbox.paygentic.io"],"title":"List Entitlements","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ec0a5f67-67f9-4223-9b61-c84134dace5f":{"name":"customerId","in":"query","required":false,"schema":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"The Paygentic customer id to retrieve entitlements for. Supply exactly one of `customerId` or `externalCustomerId`. When combined with `merchantId`, the customer must belong to that merchant or the request resolves to not found.\nUnique identifier for a customer","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"The Paygentic customer id to retrieve entitlements for. Supply exactly one of `customerId` or `externalCustomerId`. When combined with `merchantId`, the customer must belong to that merchant or the request resolves to not found.","example":"cus_q3r4s5t6u7v8w9x0"},"d8713a11-0637-4288-a07b-003540fd0520":{"name":"externalCustomerId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"The merchant's own external customer reference (`Customer.externalId`, exact match), used to retrieve entitlements without first resolving it to a `cus_` id. Matches the `externalId` filter on `GET /v1/customers` (plain string, exact match — no pattern constraint, so any stored `externalId` is addressable). Supply exactly one of `customerId` or `externalCustomerId`. `externalId` is unique only within a merchant, so an effective merchant scope is required: either pass `merchantId`, or authenticate with a single-merchant API key. With no resolvable merchant scope the request is rejected.","uniqueKey":"","typeLabel":"string"},"description":"The merchant's own external customer reference (`Customer.externalId`, exact match), used to retrieve entitlements without first resolving it to a `cus_` id. Matches the `externalId` filter on `GET /v1/customers` (plain string, exact match — no pattern constraint, so any stored `externalId` is addressable). Supply exactly one of `customerId` or `externalCustomerId`. `externalId` is unique only within a merchant, so an effective merchant scope is required: either pass `merchantId`, or authenticate with a single-merchant API key. With no resolvable merchant scope the request is rejected.","example":"ext-customer-123"},"12cd1be1-3a26-4ec1-a12f-f3769a21d287":{"name":"merchantId","in":"query","required":false,"schema":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"Optional merchant scope. With `externalCustomerId` it selects the merchant the external id is resolved within (required for the platform key, which has no single merchant). With `customerId` it acts as a tenant guard — the resolved customer must belong to this merchant, otherwise the request resolves to not found. A passed `merchantId` is only a filter and never grants access the caller does not already hold; authorization is always evaluated against the resolved customer's merchant.\nUnique identifier for an organization","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Optional merchant scope. With `externalCustomerId` it selects the merchant the external id is resolved within (required for the platform key, which has no single merchant). With `customerId` it acts as a tenant guard — the resolved customer must belong to this merchant, otherwise the request resolves to not found. A passed `merchantId` is only a filter and never grants access the caller does not already hold; authorization is always evaluated against the resolved customer's merchant.","example":"org_a1b2c3d4e5f6g7h8"},"5838d2b3-d797-44bb-829d-39080aad6ce7":{"name":"featureKey","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Filter results to a specific feature by its key. When specified, `productId` is also required. Use this to check access to a single feature.","uniqueKey":"","typeLabel":"string"},"description":"Filter results to a specific feature by its key. When specified, `productId` is also required. Use this to check access to a single feature."},"43ee1859-816f-40b2-95a4-94195a08d1b5":{"name":"productId","in":"query","required":false,"schema":{"type":"string","pattern":"^prod_[a-zA-Z0-9]+$","description":"Filter results to entitlements for a specific product. Required when `featureKey` is specified since feature keys are scoped to products.\nUnique identifier for a product","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Filter results to entitlements for a specific product. Required when `featureKey` is specified since feature keys are scoped to products."},"f43bba38-dd71-409f-91a4-24266d798ca2":{"name":"subscriptionId","in":"query","required":false,"schema":{"type":"string","pattern":"^sub_[a-zA-Z0-9]+$","description":"Filter results to entitlements for a specific subscription.\nUnique identifier for a subscription","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"Filter results to entitlements for a specific subscription."},"902326ae-4b54-405c-b1e7-97f4bbd6aa12":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":10,"isRequired":false,"description":"Maximum number of entitlements to return per page. Use with `offset` for pagination.","uniqueKey":"","typeLabel":"integer"},"description":"Maximum number of entitlements to return per page. Use with `offset` for pagination."},"8c2667f3-a3aa-46b0-93fa-3226180b7822":{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"isRequired":false,"description":"Number of entitlements to skip. Use with `limit` for pagination through large result sets.","uniqueKey":"","typeLabel":"integer"},"description":"Number of entitlements to skip. Use with `limit` for pagination through large result sets."},"91ab4e1d-f0af-4c57-9c83-c1a1c225b94a":{"name":"at","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Evaluate balance and access at this point in time (RFC 3339 datetime with any UTC offset, e.g. 2024-01-15T10:30:00Z or 2024-01-15T15:30:00+05:30). Defaults to current time."}},"responses":{"11906286-c19b-4fc0-82b4-3f693f279838":{"description":"Successfully retrieved the list of entitlements for the customer.","content":{"application/json":{"schema":{"type":"object","required":["object","data","pagination"],"properties":{"object":{"type":"string","enum":["list"],"default":"list","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"data":{"type":"array","items":{"oneOf":[{"type":"object","description":"An entitlement as returned by the list endpoint. The shape varies by featureType. Uses `entitlementId` (not `id`) for backwards compatibility with the original list contract.","required":["config","entitlementId","customerId","featureId","featureKey","featureType","productId","subscriptionId","status","activeFrom","activeTo","hasAccess","metadata"],"properties":{"entitlementId":{"type":"string","pattern":"^ent_[a-zA-Z0-9]+$","description":"Unique identifier for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.entitlementId","typeLabel":"string"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.customerId","typeLabel":"string"},"featureId":{"type":"string","pattern":"^feat_[a-zA-Z0-9]+$","description":"The feature this entitlement grants access to.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.featureId","typeLabel":"string"},"featureKey":{"type":"string","description":"The unique key identifying the feature.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.featureKey","typeLabel":"string"},"featureType":{"type":"string","description":"The type of feature.","enum":["boolean"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.featureType","typeLabel":"enum\u003cstring>"},"productId":{"type":"string","pattern":"^prod_[a-zA-Z0-9]+$","description":"Unique identifier for a product","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.productId","typeLabel":"string"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.subscriptionId","typeLabel":"string | null"},"status":{"type":"string","enum":["active","canceled","expired"],"description":"Current status of the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"activeFrom":{"type":"string","format":"date-time","description":"When the entitlement becomes active.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.activeFrom","typeLabel":"string\u003cdate-time>"},"activeTo":{"oneOf":[{"type":"string","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.activeTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.activeTo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.activeTo","typeLabel":"string\u003cdate-time> | null"},"hasAccess":{"type":"boolean","description":"Whether the customer currently has active access to this entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.hasAccess","typeLabel":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.metadata","typeLabel":"object"},"config":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Always `null` for boolean entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.config.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Always `null` for boolean entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.config.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.0.config","typeLabel":"object | null"}},"uniqueKey":"data.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An entitlement as returned by the list endpoint. The shape varies by featureType. Uses `entitlementId` (not `id`) for backwards compatibility with the original list contract.","required":["config","entitlementId","customerId","featureId","featureKey","featureType","productId","subscriptionId","status","activeFrom","activeTo","hasAccess","metadata"],"properties":{"entitlementId":{"type":"string","pattern":"^ent_[a-zA-Z0-9]+$","description":"Unique identifier for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.entitlementId","typeLabel":"string"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.customerId","typeLabel":"string"},"featureId":{"type":"string","pattern":"^feat_[a-zA-Z0-9]+$","description":"The feature this entitlement grants access to.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.featureId","typeLabel":"string"},"featureKey":{"type":"string","description":"The unique key identifying the feature.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.featureKey","typeLabel":"string"},"featureType":{"type":"string","description":"The type of feature.","enum":["static"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.featureType","typeLabel":"enum\u003cstring>"},"productId":{"type":"string","pattern":"^prod_[a-zA-Z0-9]+$","description":"Unique identifier for a product","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.productId","typeLabel":"string"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.subscriptionId","typeLabel":"string | null"},"status":{"type":"string","enum":["active","canceled","expired"],"description":"Current status of the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"},"activeFrom":{"type":"string","format":"date-time","description":"When the entitlement becomes active.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.activeFrom","typeLabel":"string\u003cdate-time>"},"activeTo":{"oneOf":[{"type":"string","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.activeTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.activeTo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.activeTo","typeLabel":"string\u003cdate-time> | null"},"hasAccess":{"type":"boolean","description":"Whether the customer currently has active access to this entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.hasAccess","typeLabel":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.metadata","typeLabel":"object"},"config":{"type":"object","additionalProperties":true,"description":"Configuration values for this entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.1.config","typeLabel":"object"}},"uniqueKey":"data.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An entitlement as returned by the list endpoint. The shape varies by featureType. Uses `entitlementId` (not `id`) for backwards compatibility with the original list contract.","required":["balance","usageInPeriod","overage","isSoftLimit","config","currentPeriodStart","currentPeriodEnd","pricingUnitId","usageCountedFrom","billableMetricId","usageNotCountedUrl","entitlementId","customerId","featureId","featureKey","featureType","productId","subscriptionId","status","activeFrom","activeTo","hasAccess","metadata"],"properties":{"entitlementId":{"type":"string","pattern":"^ent_[a-zA-Z0-9]+$","description":"Unique identifier for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.entitlementId","typeLabel":"string"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.customerId","typeLabel":"string"},"featureId":{"type":"string","pattern":"^feat_[a-zA-Z0-9]+$","description":"The feature this entitlement grants access to.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.featureId","typeLabel":"string"},"featureKey":{"type":"string","description":"The unique key identifying the feature.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.featureKey","typeLabel":"string"},"featureType":{"type":"string","description":"The type of feature.","enum":["metered"],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.featureType","typeLabel":"enum\u003cstring>"},"productId":{"type":"string","pattern":"^prod_[a-zA-Z0-9]+$","description":"Unique identifier for a product","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.productId","typeLabel":"string"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription this entitlement is associated with, if any.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.subscriptionId","typeLabel":"string | null"},"status":{"type":"string","enum":["active","canceled","expired"],"description":"Current status of the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"activeFrom":{"type":"string","format":"date-time","description":"When the entitlement becomes active.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.activeFrom","typeLabel":"string\u003cdate-time>"},"activeTo":{"oneOf":[{"type":"string","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.activeTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When the entitlement expires. Null means no expiration.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.activeTo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.activeTo","typeLabel":"string\u003cdate-time> | null"},"hasAccess":{"type":"boolean","description":"Whether the customer currently has active access to this entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.hasAccess","typeLabel":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the entitlement.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.metadata","typeLabel":"object"},"config":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Always `null` for metered entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.config.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Always `null` for metered entitlements. Surfaced on every list item so clients can read `item.config` without first switching on `featureType`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.config.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.config","typeLabel":"object | null"},"isSoftLimit":{"type":"boolean","description":"When false (hard limit), access is blocked when balance is exhausted and overage is not charged on invoices. When true (soft limit), access continues past the grant and overage is charged at the per-unit rate.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.isSoftLimit","typeLabel":"boolean"},"balance":{"type":"number","description":"Remaining balance for the current period. When `pricingUnitId` is set, this is expressed in that pricing unit's credits (a balance shared across every feature drawing the same unit); otherwise it is in the feature's native metered units.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.balance","typeLabel":"number"},"usageInPeriod":{"type":"number","description":"Total usage consumed in the current billing period, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units). When `pricingUnitId` is set, this is the shared-pool aggregate across every feature drawing the same unit, not usage specific to this feature.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageInPeriod","typeLabel":"number"},"overage":{"type":"number","description":"Amount of usage exceeding the balance, in the same unit as `balance` (credits when `pricingUnitId` is set, otherwise native metered units).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.overage","typeLabel":"number"},"pricingUnitId":{"oneOf":[{"type":"string","pattern":"^pu_[a-zA-Z0-9]+$","description":"The pricing unit this feature is denominated in when it draws a credit pool. When set, `balance`/`usageInPeriod`/`overage` are in that unit's credits and reflect a balance shared across all features on the same unit. `null` for currency-denominated features (native metered units).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.pricingUnitId.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^pu_[a-zA-Z0-9]+$","description":"The pricing unit this feature is denominated in when it draws a credit pool. When set, `balance`/`usageInPeriod`/`overage` are in that unit's credits and reflect a balance shared across all features on the same unit. `null` for currency-denominated features (native metered units).","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.pricingUnitId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.pricingUnitId","typeLabel":"string | null"},"currentPeriodStart":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation \"dark window\", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodStart.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation \"dark window\", when the query time is earlier than `activeFrom`) this instead describes the pre-activation `[subscription start, activation)` window and may be `null` when there is no associated subscription.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodStart.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodStart","typeLabel":"string\u003cdate-time> | null"},"currentPeriodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"End of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation \"dark window\", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the current usage period. These bounds describe this entitlement's own usage window (not the shared pool's), even for a pool-backed feature (`pricingUnitId` set) whose `balance` and `usageInPeriod` are shared-pool aggregates. Before the entitlement activates (the pre-activation \"dark window\", when the query time is earlier than `activeFrom`) this instead holds `activeFrom` — the end of the pre-activation `[subscription start, activation)` window.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodEnd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.currentPeriodEnd","typeLabel":"string\u003cdate-time> | null"},"usageCountedFrom":{"oneOf":[{"type":"string","format":"date-time","description":"Usage counts against `balance` only if it is dated at or after this moment. It is the later of the entitlement's start and when Paygentic created it, or the test clock's time when the subscription runs on one, and it never changes after the entitlement is created. When `pricingUnitId` is set, it is instead the moment the customer's credit pool for that unit was created, because the pool's balance is the one that applies. It is `null` until that pool exists, since there is no balance to count against yet, and never changes once set. Usage dated earlier is still accepted and still shows on the metric's meter, but never draws down this balance; `usageNotCountedUrl` returns it.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageCountedFrom.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Usage counts against `balance` only if it is dated at or after this moment. It is the later of the entitlement's start and when Paygentic created it, or the test clock's time when the subscription runs on one, and it never changes after the entitlement is created. When `pricingUnitId` is set, it is instead the moment the customer's credit pool for that unit was created, because the pool's balance is the one that applies. It is `null` until that pool exists, since there is no balance to count against yet, and never changes once set. Usage dated earlier is still accepted and still shows on the metric's meter, but never draws down this balance; `usageNotCountedUrl` returns it.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageCountedFrom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageCountedFrom","typeLabel":"string\u003cdate-time> | null"},"billableMetricId":{"oneOf":[{"type":"string","description":"The billable metric this entitlement measures. `null` only for a metered entitlement issued directly with no price attached.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.billableMetricId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The billable metric this entitlement measures. `null` only for a metered entitlement issued directly with no price attached.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.billableMetricId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.billableMetricId","typeLabel":"string | null"},"usageNotCountedUrl":{"oneOf":[{"type":"string","format":"uri","description":"A link to the meter (`GET /v0/billableMetrics/{id}/meter`) for this customer and `billableMetricId`, covering the 403 days before `usageCountedFrom` and ending at it (exclusive). It returns the usage the metric recorded that this balance does not count because it is dated before `usageCountedFrom`. An event dated exactly at `usageCountedFrom` counts against the balance and is not in it. The total covers every event on the metric for this customer, so it can include usage an earlier entitlement already counted: one from an earlier subscription, or from before a plan change on the same subscription. `null` when `pricingUnitId` is set (the balance is in credits, and a native-unit total beside it would mislead) or when `billableMetricId` is `null`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageNotCountedUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"A link to the meter (`GET /v0/billableMetrics/{id}/meter`) for this customer and `billableMetricId`, covering the 403 days before `usageCountedFrom` and ending at it (exclusive). It returns the usage the metric recorded that this balance does not count because it is dated before `usageCountedFrom`. An event dated exactly at `usageCountedFrom` counts against the balance and is not in it. The total covers every event on the metric for this customer, so it can include usage an earlier entitlement already counted: one from an earlier subscription, or from before a plan change on the same subscription. `null` when `pricingUnitId` is set (the balance is in credits, and a native-unit total beside it would mislead) or when `billableMetricId` is `null`.","isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageNotCountedUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].oneOf.2.usageNotCountedUrl","typeLabel":"string\u003curi> | null"}},"uniqueKey":"data.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"description":"Array of entitlement list items. The shape of each item varies by featureType.","isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"pagination":{"type":"object","description":"Offset-based pagination response.","properties":{"limit":{"type":"integer","description":"Requested page size.","isRequired":true,"uniqueKey":"pagination.limit","typeLabel":"integer"},"offset":{"type":"integer","description":"Number of items skipped.","isRequired":true,"uniqueKey":"pagination.offset","typeLabel":"integer"},"total":{"type":"integer","description":"Total number of items available.","isRequired":true,"uniqueKey":"pagination.total","typeLabel":"integer"}},"required":["limit","offset","total"],"isRequired":true,"uniqueKey":"pagination","typeLabel":"object"},"stale":{"type":"object","description":"Present only when the database can't be reached, or the list takes more than a second to compute. The response is then the last result for this same request in the past hour, computed at `computedAt`.","required":["computedAt"],"properties":{"computedAt":{"type":"string","format":"date-time","description":"When this result was computed.","isRequired":true,"uniqueKey":"stale.computedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"stale","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"multipleEntitlements":{"title":"multipleEntitlements","summary":"Multiple entitlements with different feature types","description":"A customer with a Pro plan that includes seat limits (static) and SSO access (boolean).","value":{"object":"list","data":[{"entitlementId":"ent_a7b8c9d0e1f2g3h4","customerId":"cus_q3r4s5t6u7v8w9x0","featureId":"feat_max_users","featureKey":"max_users","featureType":"static","productId":"prod_m5n6o7p8q9r0s1t2","subscriptionId":"sub_pro_plan","status":"active","activeFrom":"2024-01-01T00:00:00Z","activeTo":"2025-01-01T00:00:00Z","hasAccess":true,"metadata":{},"config":{"limit":25}},{"entitlementId":"ent_b8c9d0e1f2g3h4i5","customerId":"cus_q3r4s5t6u7v8w9x0","featureId":"feat_sso_enabled","featureKey":"sso_enabled","featureType":"boolean","productId":"prod_m5n6o7p8q9r0s1t2","subscriptionId":"sub_pro_plan","status":"active","activeFrom":"2024-01-01T00:00:00Z","activeTo":null,"hasAccess":true,"metadata":{},"config":null}],"pagination":{"limit":10,"offset":0,"total":2}}},"staticFeatureWithConfig":{"title":"staticFeatureWithConfig","summary":"Static feature with configuration","description":"An entitlement for a feature that includes configuration values the customer is entitled to.","value":{"object":"list","data":[{"entitlementId":"ent_d0e1f2g3h4i5j6k7","customerId":"cus_q3r4s5t6u7v8w9x0","featureId":"feat_storage_quota","featureKey":"storage_quota","featureType":"static","productId":"prod_storage123456","subscriptionId":"sub_storage_plan","status":"active","activeFrom":"2024-03-15T00:00:00Z","activeTo":null,"hasAccess":true,"metadata":{},"config":{"limitGB":500,"allowedFileTypes":["pdf","doc","xlsx","png","jpg"]}}],"pagination":{"limit":10,"offset":0,"total":1}}},"expiredEntitlement":{"title":"expiredEntitlement","summary":"Entitlement that is no longer active","description":"A canceled entitlement where hasAccess is false. This can happen when a subscription is canceled or expires.","value":{"object":"list","data":[{"entitlementId":"ent_e1f2g3h4i5j6k7l8","customerId":"cus_q3r4s5t6u7v8w9x0","featureId":"feat_premium_support","featureKey":"premium_support","featureType":"boolean","productId":"prod_support789012","subscriptionId":null,"status":"expired","activeFrom":"2023-01-01T00:00:00Z","activeTo":"2024-01-01T00:00:00Z","hasAccess":false,"metadata":{},"config":null}],"pagination":{"limit":10,"offset":0,"total":1}}},"meteredEntitlement":{"title":"meteredEntitlement","summary":"Metered entitlement with cap and live usage","description":"A usage-based feature with a hard cap (`isSoftLimit: false`) and live balance, usage, and period bounds from the grant engine.","value":{"object":"list","data":[{"entitlementId":"ent_c9d0e1f2g3h4i5j6","customerId":"cus_q3r4s5t6u7v8w9x0","featureId":"feat_api_calls","featureKey":"api_calls","featureType":"metered","productId":"prod_m5n6o7p8q9r0s1t2","subscriptionId":"sub_pro_plan","status":"active","activeFrom":"2024-03-01T00:00:00Z","activeTo":null,"hasAccess":true,"metadata":{},"config":null,"isSoftLimit":false,"balance":8340,"usageInPeriod":1660,"overage":0,"currentPeriodStart":"2024-03-01T00:00:00Z","currentPeriodEnd":"2024-04-01T00:00:00Z","pricingUnitId":null,"usageCountedFrom":"2024-03-01T00:00:00Z","billableMetricId":"bm_a1b2c3d4e5f6g7h8","usageNotCountedUrl":"https://api.paygentic.io/v0/billableMetrics/bm_a1b2c3d4e5f6g7h8/meter?subject=cus_q3r4s5t6u7v8w9x0\u0026from=2023-01-23T00%3A00%3A00.000Z\u0026to=2024-03-01T00%3A00%3A00.000Z"}],"pagination":{"limit":10,"offset":0,"total":1}}},"emptyResult":{"title":"emptyResult","summary":"No entitlements found","description":"Response when a customer has no entitlements, or no entitlements match the filter criteria.","value":{"object":"list","data":[],"pagination":{"limit":10,"offset":0,"total":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"35790c52-b06f-4823-b204-7d06057dff24":{"description":"Bad Request - The request could not be understood or was missing required parameters","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["message"],"example":{"message":"The requested resource was not found","error":"not_found"},"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"oneOf.0.error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"oneOf.0.code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"oneOf.0.details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"oneOf.0.reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"oneOf.0.requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["message","errors"],"example":{"message":"Validation failed","error":"validation_error","errors":[{"field":"email","message":"Invalid email format","code":"invalid_format"}]},"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The field that failed validation","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Validation error message for this field","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation error code","uniqueKey":"oneOf.1.errors.items.[INDEX].code","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"description":"Array of field-specific validation errors","isRequired":true,"uniqueKey":"oneOf.1.errors","typeLabel":"object[]"},"error":{"type":"string","enum":["validation_error"],"default":"validation_error","description":"Error type indicating validation failure","uniqueKey":"oneOf.1.error","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"284e6466-3845-405a-aebc-7e66cf8100e7":{"description":"Forbidden - Request is understood but refused","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"14751237-fdff-466b-bca9-003e8687e757":{"description":"Not Found - The requested resource could not be found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"881bf2f4-fca1-4bf4-a2cf-66218ba4f82a":{"description":"Internal Server Error - Something went wrong on the server side","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"341ede1c-db03-4e32-b951-0c478552f430":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"7498f67e-c06f-4d11-9a4e-7c43f0f53b26":{"url":"https://api.paygentic.io","description":"Production API"},"d0f74462-aeec-4209-82f4-dbb60498c1a2":{"url":"https://api.sandbox.paygentic.io","description":"Sandbox API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"paygentic","siteName":"Paygentic","title":"List Entitlements - Paygentic","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T01:05:01.386Z","originalFileLocation":"api-reference/entitlements/list-entitlements.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve all entitlements for a customer, optionally filtered by feature or product. List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: \u0026quot;entitlement\u0026quot; instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call. For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Entitlements - Paygentic\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve all entitlements for a customer, optionally filtered by feature or product. List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: \u0026quot;entitlement\u0026quot; instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call. For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paygentic\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=List+Entitlements\u0026amp;description=Retrieve+all+entitlements+for+a+customer%2C+optionally+filtered+by+feature+or+product.%0A%0AList+items+identify+the+entitlement+with+%60entitlementId%60+%28the+original+lis\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=ba9dc19dcbddc47af49793619868ad2347d5e8f2c130271959e00134180aed2c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Entitlements - Paygentic\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve all entitlements for a customer, optionally filtered by feature or product. List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: \u0026quot;entitlement\u0026quot; instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call. For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=List+Entitlements\u0026amp;description=Retrieve+all+entitlements+for+a+customer%2C+optionally+filtered+by+feature+or+product.%0A%0AList+items+identify+the+entitlement+with+%60entitlementId%60+%28the+original+lis\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=ba9dc19dcbddc47af49793619868ad2347d5e8f2c130271959e00134180aed2c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#013F70\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/entitlements/list-entitlements.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paygentic.io/#organization\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paygentic.io#website\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements#webpage\",\"url\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements\",\"name\":\"List Entitlements\",\"description\":\"Retrieve all entitlements for a customer, optionally filtered by feature or product. List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: \\\"entitlement\\\" instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call. For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).\",\"dateModified\":\"2026-11-22T01:05:01.386Z\",\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Paygentic\",\"item\":\"https://docs.paygentic.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Entitlements\",\"item\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements#apireference\",\"headline\":\"List Entitlements\",\"name\":\"List Entitlements\",\"description\":\"Retrieve all entitlements for a customer, optionally filtered by feature or product. List items identify the entitlement with entitlementId (the original list contract). The get-by-id endpoint (GET /v1/entitlements/{entitlementId}) returns the same object but with a top-level id and object: \\\"entitlement\\\" instead — so use item.entitlementId, not item.id, when chaining a list result into a get-by-id call. For metered entitlements, each item carries live balance/usage fields, which the API resolves with one grant-engine balance lookup per metered item (bounded concurrency, up to limit items per page).\",\"url\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paygentic.io/api-reference/entitlements/list-entitlements#webpage\"},\"dateModified\":\"2026-11-22T01:05:01.386Z\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paygentic\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paygentic\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/entitlements/list-entitlements.md","siteName":"Paygentic","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Me","pages":[{"title":"Get the caller","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/me","href":"/api-reference/me/get-the-caller"}]},{"group":"Billable Metrics","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics","href":"/api-reference/billable-metrics/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billableMetrics","href":"/api-reference/billable-metrics/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/update"},{"title":"Query Meter Usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/meter","href":"/api-reference/billable-metrics/query-meter-usage"},{"title":"List Meter Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/events","href":"/api-reference/billable-metrics/list-meter-events"}]},{"group":"Customers","pages":[{"title":"List by Merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers","href":"/api-reference/customers/list-by-merchant"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers","href":"/api-reference/customers/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}","href":"/api-reference/customers/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/customers/{id}","href":"/api-reference/customers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/customers/{id}","href":"/api-reference/customers/update"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/list-payment-methods"},{"title":"Set up a payment method","description":"Create a payment session that captures a new off-session payment method for this customer without charging. The response contains a hosted-page URL — redirect the customer to it, or load it inside an iframe (when iframed, the page reports outcomes via `postMessage` to the parent window).","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/set-up-a-payment-method"}]},{"group":"Entitlements","pages":[{"title":"List Entitlements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Issue Entitlement","description":"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.","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements","href":"/api-reference/entitlements/issue-entitlement"},{"title":"Get Entitlement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}","href":"/api-reference/entitlements/get-entitlement"}]},{"group":"Grants","pages":[{"title":"List Grants","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/list-grants"},{"title":"Create Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/create-grant"},{"title":"Purchase Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants/purchase","href":"/api-reference/grants/purchase-grant"},{"title":"Get Grant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/get-grant"},{"title":"Void Grant","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/void-grant"}]},{"group":"Features","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features","href":"/api-reference/features/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/features","href":"/api-reference/features/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features/{id}","href":"/api-reference/features/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/features/{id}","href":"/api-reference/features/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/features/{id}","href":"/api-reference/features/update"}]},{"group":"Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees","href":"/api-reference/fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/fees","href":"/api-reference/fees/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees/{id}","href":"/api-reference/fees/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/fees/{id}","href":"/api-reference/fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/fees/{id}","href":"/api-reference/fees/update"}]},{"group":"Plans","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans","href":"/api-reference/plans/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans","href":"/api-reference/plans/create"},{"title":"List Available Plans","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/available","href":"/api-reference/plans/list-available-plans"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}","href":"/api-reference/plans/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}","href":"/api-reference/plans/update"},{"title":"List versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions","href":"/api-reference/plans/list-versions"},{"title":"Mint a plan version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans/{id}/versions","href":"/api-reference/plans/mint-a-plan-version"},{"title":"Get a version","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/get-a-version"},{"title":"Set the default version","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/set-the-default-version"}]},{"group":"Prices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices","href":"/api-reference/prices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/prices","href":"/api-reference/prices/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices/{id}","href":"/api-reference/prices/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/prices/{id}","href":"/api-reference/prices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/prices/{id}","href":"/api-reference/prices/update"}]},{"group":"Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products","href":"/api-reference/products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/products","href":"/api-reference/products/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products/{id}","href":"/api-reference/products/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/products/{id}","href":"/api-reference/products/update"}]},{"group":"Sources","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources","href":"/api-reference/sources/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources","href":"/api-reference/sources/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}","href":"/api-reference/sources/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sources/{id}","href":"/api-reference/sources/update"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}/events","href":"/api-reference/sources/list-events"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/approve","href":"/api-reference/sources/approve"},{"title":"Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/reject","href":"/api-reference/sources/reject"},{"title":"Bulk Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-approve","href":"/api-reference/sources/bulk-approve"},{"title":"Bulk Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-reject","href":"/api-reference/sources/bulk-reject"},{"title":"List Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules","href":"/api-reference/sources/list-rules"},{"title":"Create Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sourceRules","href":"/api-reference/sources/create-rule"},{"title":"Get Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules/{ruleId}","href":"/api-reference/sources/get-rule"},{"title":"Delete Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/sourceRules/{ruleId}","href":"/api-reference/sources/delete-rule"},{"title":"Update Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sourceRules/{ruleId}","href":"/api-reference/sources/update-rule"}]},{"group":"Subscriptions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions","href":"/api-reference/subscriptions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions","href":"/api-reference/subscriptions/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}","href":"/api-reference/subscriptions/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptions/{id}","href":"/api-reference/subscriptions/update"},{"title":"Get Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/get-price-intervals"},{"title":"Edit Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/edit-price-intervals"},{"title":"Migrate To A Plan Version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/versionMigration","href":"/api-reference/subscriptions/migrate-to-a-plan-version"},{"title":"List Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervalChanges","href":"/api-reference/subscriptions/list-interval-changes"},{"title":"List Merchant Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/intervalChanges","href":"/api-reference/subscriptions/list-merchant-interval-changes"},{"title":"Generate Portal Link","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/portal","href":"/api-reference/subscriptions/generate-portal-link"},{"title":"Terminate","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/termination","href":"/api-reference/subscriptions/terminate"},{"title":"Reconcile Features","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/reconciliations","href":"/api-reference/subscriptions/reconcile-features"},{"title":"List Adjustments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/list-adjustments"},{"title":"Create Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/create-adjustment"},{"title":"Delete Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/subscriptions/{id}/adjustments/{adjustmentId}","href":"/api-reference/subscriptions/delete-adjustment"}]},{"group":"Subscription Proposals","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/get"},{"title":"Amend","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/amend"},{"title":"Approve or reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals/{id}/decision","href":"/api-reference/subscription-proposals/approve-or-reject"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}/projected","href":"/api-reference/subscription-proposals/list-projected"}]},{"group":"Users","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/users/{id}","href":"/api-reference/users/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/users/{id}","href":"/api-reference/users/update"}]},{"group":"Invoices V2","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices","href":"/api-reference/invoices-v2/list"},{"title":"List Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/lineItems","href":"/api-reference/invoices-v2/list-line-items"},{"title":"Create Manual Line Item","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/lineItems","href":"/api-reference/invoices-v2/create-manual-line-item"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/projected","href":"/api-reference/invoices-v2/list-projected"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}","href":"/api-reference/invoices-v2/get"},{"title":"Get Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/lineItems","href":"/api-reference/invoices-v2/get-line-items"},{"title":"Download Invoice PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/pdf","href":"/api-reference/invoices-v2/download-invoice-pdf"},{"title":"Settle Invoice Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/payment","href":"/api-reference/invoices-v2/settle-invoice-payment"},{"title":"List Invoice Refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/list-invoice-refunds"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/refund-invoice"},{"title":"Void Invoice Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds/{refundId}/void","href":"/api-reference/invoices-v2/void-invoice-refund"},{"title":"Retry Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/retryPayment","href":"/api-reference/invoices-v2/retry-payment"}]},{"group":"Payments","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments","href":"/api-reference/payments/list-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/payments","href":"/api-reference/payments/create-payment"},{"title":"Get Payment","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments/{id}","href":"/api-reference/payments/get-payment"}]},{"group":"Payment Sessions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/paymentSessions","href":"/api-reference/payment-sessions/list"}]},{"group":"Events","pages":[{"title":"Ingest Event","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/events","href":"/api-reference/events/ingest-event"}]},{"group":"Costs","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs","href":"/api-reference/costs/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/costs","href":"/api-reference/costs/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}","href":"/api-reference/costs/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/costs/{id}","href":"/api-reference/costs/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/costs/{id}","href":"/api-reference/costs/update"},{"title":"Query Summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}/summary","href":"/api-reference/costs/query-summary"},{"title":"Report","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/report","href":"/api-reference/costs/report"}]},{"group":"Revenue","pages":[{"title":"Get revenue summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue","href":"/api-reference/revenue/get-revenue-summary"},{"title":"List customer accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue/accounts","href":"/api-reference/revenue/list-customer-accounts"}]},{"group":"Profitability","pages":[{"title":"Get profitability summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/profitability","href":"/api-reference/profitability/get-profitability-summary"}]},{"group":"Test Clocks","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks","href":"/api-reference/test-clocks/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/testClocks","href":"/api-reference/test-clocks/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks/{id}","href":"/api-reference/test-clocks/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/testClocks/{id}","href":"/api-reference/test-clocks/delete"},{"title":"Advance","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/testClocks/{id}","href":"/api-reference/test-clocks/advance"}]},{"group":"Merchant Data","pages":[{"title":"Reset a merchant's data","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/merchants/{merchantId}/reset","href":"/api-reference/merchant-data/reset-a-merchants-data"}]},{"group":"ExternalReferences","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences","href":"/api-reference/externalreferences/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/externalReferences","href":"/api-reference/externalreferences/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences/{id}","href":"/api-reference/externalreferences/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/externalReferences/{id}","href":"/api-reference/externalreferences/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/externalReferences/{id}","href":"/api-reference/externalreferences/update"}]},{"group":"Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items","href":"/api-reference/items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/items","href":"/api-reference/items/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items/{id}","href":"/api-reference/items/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/items/{id}","href":"/api-reference/items/update"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders","href":"/api-reference/orders/create-an-order"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{id}","href":"/api-reference/orders/delete-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Add a line item","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/lineItems","href":"/api-reference/orders/add-a-line-item"},{"title":"Delete a line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/delete-a-line-item"},{"title":"Update a line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/update-a-line-item"},{"title":"Create an approval for the order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/approvals","href":"/api-reference/orders/create-an-approval-for-the-order"}]},{"group":"Billing Schedules","pages":[{"title":"List billing schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules","href":"/api-reference/billing-schedules/list-billing-schedules"},{"title":"Create a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules","href":"/api-reference/billing-schedules/create-a-billing-schedule"},{"title":"Get a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/get-a-billing-schedule"},{"title":"Delete a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/delete-a-billing-schedule"},{"title":"Update a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/update-a-billing-schedule"},{"title":"List schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/list-schedule-intervals"},{"title":"Replace schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/replace-schedule-intervals"},{"title":"List staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/list-staged-invoices"},{"title":"Generate staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/generate-staged-invoices"}]},{"group":"Salesforce","pages":[{"title":"List Salesforce accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/integrations/salesforce/accounts","href":"/api-reference/salesforce/list-salesforce-accounts"}]},{"group":"MerchantIntegrations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/list"},{"title":"Upsert","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/upsert"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations/{id}","href":"/api-reference/merchantintegrations/get"},{"title":"Disconnect","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/merchantIntegrations/{id}/disconnect","href":"/api-reference/merchantintegrations/disconnect"}]},{"group":"Approvals","pages":[{"title":"List approvals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals","href":"/api-reference/approvals/list-approvals"},{"title":"Submit a resource for approval","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/approvals","href":"/api-reference/approvals/submit-a-resource-for-approval"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals/{id}","href":"/api-reference/approvals/get-an-approval"},{"title":"Update an approval (approve, reject, or cancel)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/approvals/{id}","href":"/api-reference/approvals/update-an-approval-approve-reject-or-cancel"}]},{"group":"Webhooks","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks","href":"/api-reference/webhooks/get"},{"title":"Enable","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/webhooks","href":"/api-reference/webhooks/enable"},{"title":"Disable","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/webhooks","href":"/api-reference/webhooks/disable"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/webhooks","href":"/api-reference/webhooks/update"},{"title":"Get Portal Access","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks/portal","href":"/api-reference/webhooks/get-portal-access"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"List Entitlements - Paygentic","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}