Stripe

Stripe Entitlements API

Entitlements enable you to map the features of your internal service to Stripe products. After you map your features, Stripe notifies you about when to provision or de-provision access according to your customers subscription status.

GitHub OpenAPI
Business capability
Subscription Lifecycle Management BC-4240

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/entitlements/active_entitlements List a customer's active entitlements · Stripe List Active Entitlements #
Ask an LLM
“Which features does a customer currently have access to?”
“How do I check what a customer's subscription unlocks in my app?”
Tell an agent
List active entitlements for customer {customer}.
Show up to {limit} features customer {customer} is entitled to.
GET /v1/entitlements/active_entitlements/{id} Get an active entitlement · Stripe Retrieve Active Entitlement #
Ask an LLM
“How do I look up a single active entitlement?”
“Which feature does a given active entitlement grant?”
Tell an agent
Show active entitlement {id}.
Get the feature granted by entitlement {id}.
GET /v1/entitlements/features List entitlement features · Stripe List Features #
Ask an LLM
“Which features have I defined for gating access by plan?”
“How do I see all the features I can attach to products?”
Tell an agent
List my entitlement features.
Show the first {limit} features.
POST /v1/entitlements/features Create a feature customers can be entitled to · Stripe Create Feature #
Ask an LLM
“How do I define a feature I want to gate behind a plan?”
“What is a feature lookup key used for?”
Tell an agent
Create a feature named {name} with lookup key {lookup_key}.
Add feature {name} keyed {lookup_key} with metadata {metadata}.
GET /v1/entitlements/features/{id} Get a feature · Stripe Retrieve Feature #
Ask an LLM
“How do I look up one feature's name and lookup key?”
“Is a given feature still active?”
Tell an agent
Show feature {id}.
Get the lookup key and status of feature {id}.
POST /v1/entitlements/features/{id} Update or archive a feature · Stripe Update Feature #
Ask an LLM
“How do I rename a feature?”
“Can I deactivate a feature so it's no longer granted?”
Tell an agent
Rename feature {id} to {name}.
Set feature {id} active to {active}.

Documentation

📖
Documentation
https://docs.stripe.com/billing/entitlements
📖
APIReference
https://docs.stripe.com/api/entitlements/active-entitlement

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-entitlements-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/overlays/stripe-entitlements-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stripe-entitlements-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stripe-entitlements-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stripe Accounts Account Entitlements API
  description: This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Entitlements
paths:
  /v1/entitlements/active_entitlements:
    get:
      summary: Stripe List Active Entitlements
      description: Retrieve a list of active entitlements for a customer.
      operationId: GetEntitlementsActiveEntitlements
      parameters:
      - name: customer
        in: query
        required: true
        description: The ID of the customer.
        schema:
          type: string
          maxLength: 5000
      - name: ending_before
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: starting_after
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/entitlements.active_entitlement'
                  has_more:
                    type: boolean
                  url:
                    type: string
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
  /v1/entitlements/active_entitlements/{id}:
    get:
      summary: Stripe Retrieve Active Entitlement
      description: Retrieve an active entitlement.
      operationId: GetEntitlementsActiveEntitlementsId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 5000
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlements.active_entitlement'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
  /v1/entitlements/features:
    get:
      summary: Stripe List Features
      description: Retrieve a list of features.
      operationId: GetEntitlementsFeatures
      parameters:
      - name: ending_before
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: starting_after
        in: query
        required: false
        schema:
          type: string
          maxLength: 5000
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                    - list
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/entitlements.feature'
                  has_more:
                    type: boolean
                  url:
                    type: string
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
    post:
      summary: Stripe Create Feature
      description: Creates a feature.
      operationId: PostEntitlementsFeatures
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - lookup_key
              - name
              properties:
                lookup_key:
                  type: string
                  description: A unique key you provide for the feature.
                  maxLength: 5000
                name:
                  type: string
                  description: The feature's name, for your own purpose, not meant to be displayable to the customer.
                  maxLength: 80
                metadata:
                  type: object
                  additionalProperties:
                    type: string
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlements.feature'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
  /v1/entitlements/features/{id}:
    get:
      summary: Stripe Retrieve Feature
      description: Retrieves a feature.
      operationId: GetEntitlementsFeaturesId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 5000
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlements.feature'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
    post:
      summary: Stripe Update Feature
      description: Update a feature's metadata or other properties.
      operationId: PostEntitlementsFeaturesId
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          maxLength: 5000
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                active:
                  type: boolean
                metadata:
                  type: object
                  additionalProperties:
                    type: string
                name:
                  type: string
                  maxLength: 80
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entitlements.feature'
        default:
          description: Error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      tags:
      - Entitlements
components:
  schemas:
    entitlements.active_entitlement:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
        object:
          type: string
          enum:
          - entitlements.active_entitlement
        feature:
          type: string
        livemode:
          type: boolean
        lookup_key:
          type: string
      required:
      - id
      - object
      - feature
      - livemode
      - lookup_key
    entitlements.feature:
      type: object
      properties:
        id:
          type: string
          maxLength: 5000
        object:
          type: string
          enum:
          - entitlements.feature
        active:
          type: boolean
        livemode:
          type: boolean
        lookup_key:
          type: string
          maxLength: 5000
        metadata:
          type: object
          additionalProperties:
            type: string
        name:
          type: string
          maxLength: 80
      required:
      - id
      - object
      - active
      - livemode
      - lookup_key
      - metadata
      - name
    error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            message:
              type: string
            code:
              type: string
            param:
              type: string