Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Entitlements API

7 actions 7 updates phrasing extends openapi/stripe-entitlements-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/entitlements/active_entitlements'].get
$.paths['/v1/entitlements/active_entitlements/{id}'].get
$.paths['/v1/entitlements/features'].get
$.paths['/v1/entitlements/features'].post
$.paths['/v1/entitlements/features/{id}'].get
$.paths['/v1/entitlements/features/{id}'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Accounts Account Entitlements API
  version: 1.0.0
extends: openapi/stripe-entitlements-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/entitlements/active_entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's active entitlements
      effect: read
      questions:
      - Which features does a customer currently have access to?
      - How do I check what a customer's subscription unlocks in my app?
      instructions:
      - text: List active entitlements for customer {customer}.
        slots:
          customer: query.customer
      - text: Show up to {limit} features customer {customer} is entitled to.
        slots:
          limit: query.limit
          customer: query.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entitlements/active_entitlements/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an active entitlement
      effect: read
      questions:
      - How do I look up a single active entitlement?
      - Which feature does a given active entitlement grant?
      instructions:
      - text: Show active entitlement {id}.
        slots:
          id: path.id
      - text: Get the feature granted by entitlement {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entitlements/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List entitlement features
      effect: read
      questions:
      - Which features have I defined for gating access by plan?
      - How do I see all the features I can attach to products?
      instructions:
      - text: List my entitlement features.
      - text: Show the first {limit} features.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entitlements/features'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a feature customers can be entitled to
      effect: write
      questions:
      - How do I define a feature I want to gate behind a plan?
      - What is a feature lookup key used for?
      instructions:
      - text: Create a feature named {name} with lookup key {lookup_key}.
        slots:
          name: requestBody.name
          lookup_key: requestBody.lookup_key
      - text: Add feature {name} keyed {lookup_key} with metadata {metadata}.
        slots:
          name: requestBody.name
          lookup_key: requestBody.lookup_key
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entitlements/features/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a feature
      effect: read
      questions:
      - How do I look up one feature's name and lookup key?
      - Is a given feature still active?
      instructions:
      - text: Show feature {id}.
        slots:
          id: path.id
      - text: Get the lookup key and status of feature {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/entitlements/features/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or archive a feature
      effect: write
      questions:
      - How do I rename a feature?
      - Can I deactivate a feature so it's no longer granted?
      instructions:
      - text: Rename feature {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set feature {id} active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      method: generated
      generated: '2026-09-26'