# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Billing Billing Portal API
  version: 1.0.0
extends: openapi/stripe-billing-portal-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: 5
- target: $.paths['/v1/billing_portal/configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer portal configurations
      effect: read
      questions:
      - How do I see the different setups I have for the self-service billing portal?
      - Which customer portal configuration is my default, and which are active?
      instructions:
      - text: List my customer portal configurations.
      - text: List portal configurations where active is {active}.
        slots:
          active: query.active
      - text: Show the portal configurations where default is {is_default}.
        slots:
          is_default: query.is_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing_portal/configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer portal configuration
      effect: write
      questions:
      - How do I set up a self-service portal where customers manage their own subscriptions and invoices?
      - Can I control which features, like cancelling or updating payment methods, the portal allows?
      - Can I set my privacy policy and terms links on the billing portal?
      instructions:
      - text: Create a portal configuration with business profile {business_profile} and features {features}.
        slots:
          business_profile: requestBody.business_profile
          features: requestBody.features
      - text: Create a customer portal setup with features {features}, business profile {business_profile} and return URL {default_return_url}.
        slots:
          features: requestBody.features
          business_profile: requestBody.business_profile
          default_return_url: requestBody.default_return_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing_portal/configurations/{configuration}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a customer portal configuration
      effect: read
      questions:
      - How do I check which features a particular portal configuration turns on?
      - What return URL and business details does one portal configuration use?
      instructions:
      - text: Get portal configuration {configuration}.
        slots:
          configuration: path.configuration
      - text: Show me the features enabled in portal configuration {configuration}.
        slots:
          configuration: path.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing_portal/configurations/{configuration}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer portal configuration
      effect: write
      questions:
      - How do I change what customers can do in an existing billing portal setup?
      - Can I deactivate a portal configuration I no longer want used?
      instructions:
      - text: Update the features of portal configuration {configuration} to {features}.
        slots:
          configuration: path.configuration
          features: requestBody.features
      - text: Set portal configuration {configuration} active to {active}.
        slots:
          configuration: path.configuration
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing_portal/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Open the billing portal for a customer
      effect: write
      questions:
      - How do I send a customer to a page where they can manage their subscription and billing?
      - Can I send the customer straight into a specific flow, like cancelling a subscription?
      - Can I choose the language the billing portal is shown in?
      instructions:
      - text: Create a billing portal session for customer {customer}.
        slots:
          customer: requestBody.customer
      - text: Open the billing portal for customer {customer} and return them to {return_url}.
        slots:
          customer: requestBody.customer
          return_url: requestBody.return_url
      - text: Create a portal session for customer {customer} in locale {locale}.
        slots:
          customer: requestBody.customer
          locale: requestBody.locale
      method: generated
      generated: '2026-09-26'