Entitlements report what a subscription is allowed to do, and how much of it, based on the features granted by the subscription's products and components. When more than one product or component grants the same feature, the values are aggregated into one entry per feature key and periodicity. For more information, see [Read Subscription Entitlements with the API](https://docs.maxio.com/billing/catalog/entitlements/read-subscription-entitlements-with-the-api).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/maxio:maxio-entitlements-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Maxio Entitlements API
version: '1.0'
contact:
email: support@maxio.com
description: 'Operations tagged Entitlements across 2 of this provider''s published API definitions: maxio-advanced-billing-openapi31json.json, maxio-advanced-billing-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
security:
- BasicAuth: []
tags:
- name: Entitlements
description: 'Entitlements report what a subscription is allowed to do, and how much of it, based on the features granted by the subscription''s products and components.
When more than one product or component grants the same feature, the values are aggregated into one entry per feature key and periodicity. For more information, see Read Subscription Entitlements with the API.'
paths:
/subscriptions/{subscription_id}/entitlements.json:
parameters: []
get:
tags:
- Entitlements
summary: readSubscriptionEntitlements
description: 'Returns every feature a subscription is entitled to, collapsed into one entry per feature key and periodicity window across all products and components on the subscription. A `usage_limit` feature granted with two different periodicities comes back as two entries sharing one `feature_key`, each identified by its own `periodicity_key`.
When more than one product or component grants the same feature key and periodicity, the values are combined:
- **`access_right`** features are combined with a boolean OR. If any contributor grants access, the aggregate is `true`. `source_products` only lists the contributors that granted `true`.
- **`usage_limit`** features are summed across every contributor sharing the same periodicity window. `source_products` lists every contributor. Grants with different periodicities are not summed together. Each periodicity is returned as a separate entry.
- **`service_right`** features are not combined: one contributor''s value wins. Do not rely on which one when several grant the same feature key.
`enabled` reflects both the aggregated value and the subscription''s state. The field is `false` whenever the subscription is not in a live state (`active`, `trialing`, `assessing`, `past_due`, `soft_failure`), regardless of the aggregated value. Entitlements deliberately stay enabled through dunning.'
operationId: readSubscriptionEntitlements
parameters:
- name: subscription_id
in: path
description: The Chargify id of the subscription.
required: true
schema:
type: integer
contentEncoding: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AggregatedEntitlementsResponse'
- examples:
- subscription_id: 12345
customer_id: 678
status: active
entitlements:
- feature_key: feature.sso
periodicity_key: feature.sso
name: SSO
type: access_right
value: true
enabled: true
periodicity: null
source_products:
- Gold Plan
- feature_key: usage.api_calls
periodicity_key: usage.api_calls:1:month
name: API Calls
type: usage_limit
value: 50000
enabled: true
periodicity:
interval: 1
unit: month
source_products:
- Gold Plan
contentMediaType: application/json
examples:
Example:
value:
subscription_id: 12345
customer_id: 678
status: active
entitlements:
- feature_key: feature.sso
periodicity_key: feature.sso
name: SSO
type: access_right
value: true
enabled: true
periodicity: null
source_products:
- Gold Plan
- feature_key: usage.api_calls
periodicity_key: usage.api_calls:1:month
name: API Calls
type: usage_limit
value: 50000
enabled: true
periodicity:
interval: 1
unit: month
source_products:
- Gold Plan
'403':
description: Forbidden
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ErrorListResponse1'
- description: Error which contains list of messages.
contentMediaType: application/json
'404':
description: Not Found
headers: {}
content: {}
deprecated: false
servers:
- url: https://{site}.chargify.com
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://{site}.ebilling.maxio.com
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
- url: https://events.chargify.com/{site}
description: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
variables:
site:
default: subdomain
description: The subdomain for your Advanced Billing site.
components:
schemas:
ErrorListResponse1:
title: ErrorListResponse1
required:
- errors
type: object
properties:
errors:
type: array
items:
type: string
description: ''
description: Error which contains list of messages.
EntitlementPeriodicityUnit:
title: EntitlementPeriodicityUnit
enum:
- hour
- day
- week
- month
- year
type: string
description: The recurring window over which a `usage_limit` feature's allowance resets.
AggregatedEntitlement:
title: AggregatedEntitlement
type: object
properties:
feature_key:
type: string
description: 'The feature''s key, prefixed by kind: `feature.*` for `access_right`, `usage.*` for `usage_limit`, `service.*` for `service_right`.'
examples:
- feature.sso
periodicity_key:
type: string
description: 'Uniquely identifies this aggregated entry: the prefixed feature key, suffixed with `:{interval}:{unit}` when the entitlement has a periodicity window. Equal to `feature_key` when `periodicity` is `null`.'
examples:
- usage.api_calls:1:month
name:
type: string
type:
allOf:
- $ref: '#/components/schemas/FeatureKind'
- description: 'The behavior of a feature:
- `access_right`: a boolean entitlement. A subscriber either has access or does not.
- `usage_limit`: a quantified allowance measured over a recurring period (for example, "10,000 API calls per month").
- `service_right`: a free-form value (text, boolean, or number) that isn''t a simple access flag or a metered limit.'
value:
oneOf:
- type: boolean
- type: number
- type: string
description: 'The aggregated value, coerced according to `type`: a boolean for `access_right` (and boolean `service_right`), a number for `usage_limit` (and numeric `service_right`), or a string for text `service_right`.'
enabled:
type: boolean
description: '`true` only when the aggregated value is truthy for this feature''s kind, and the subscription is in a live state (`active`, `trialing`, `assessing`, `past_due`, or `soft_failure`). `false` otherwise, including for `awaiting_signup`, canceled, expired, and on-hold subscriptions. Entitlements deliberately stay enabled through dunning.'
periodicity:
allOf:
- oneOf:
- {}
- $ref: '#/components/schemas/AggregatedEntitlementPeriodicity'
- {}
source_products:
type: array
items:
type: string
description: The names of the products/components contributing to this entitlement. For `access_right` features, only contributors that granted `true` are listed.
description: One entitlement in a subscriber's aggregated entitlements list. Entries are aggregated per feature key and periodicity window, not per feature key alone. A `usage_limit` feature granted with two different periodicities yields two entries sharing one `feature_key`. Use `periodicity_key` to identify an entry uniquely.
AggregatedEntitlementsResponse:
title: AggregatedEntitlementsResponse
required:
- subscription_id
- customer_id
- status
- entitlements
type: object
properties:
subscription_id:
type: integer
contentEncoding: int32
customer_id:
type: integer
contentEncoding: int32
status:
type: string
description: The subscription's current state, e.g. `active`, `trialing`, `canceled`.
entitlements:
type: array
items:
$ref: '#/components/schemas/AggregatedEntitlement'
description: ''
AggregatedEntitlementPeriodicity:
title: AggregatedEntitlementPeriodicity
type: object
properties:
interval:
type: integer
contentEncoding: int32
unit:
allOf:
- $ref: '#/components/schemas/EntitlementPeriodicityUnit'
- description: The recurring window over which a `usage_limit` feature's allowance resets.
FeatureKind:
title: FeatureKind
enum:
- access_right
- usage_limit
- service_right
type: string
description: 'The behavior of a feature:
- `access_right`: a boolean entitlement. A subscriber either has access or does not.
- `usage_limit`: a quantified allowance measured over a recurring period (for example, "10,000 API calls per month").
- `service_right`: a free-form value (text, boolean, or number) that isn''t a simple access flag or a metered limit.'
securitySchemes:
BasicAuth:
type: http
description: The `username` is a Maxio Chargify API key. The `password` is `x`.
scheme: basic
x-refined-from:
- maxio-advanced-billing-openapi31json.json
- maxio-advanced-billing-openapi.yml
x-provenance:
method: harvested
publisher: Maxio
source: https://developers.maxio.com/static/exports/maxio-advanced-billing-openapi31json.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)