Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Invoice API

3 actions 3 updates phrasing extends openapi/stripe-invoice-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 3

$.info

$.paths['/v1/Invoice Items'].post

$.paths['/v1/Invoice Items/{invoiceitem}'].post

OpenAPI Overlay

# 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 Invoice API
  version: 1.0.0
extends: openapi/stripe-invoice-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: 2
- target: $.paths['/v1/Invoice Items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a charge to a customer's invoice
      effect: write
      questions:
      - How do I add a one-off charge to a customer's next invoice?
      - Can I add an item to a specific draft invoice?
      - How many items can a single invoice hold?
      instructions:
      - text: Add a {amount} {currency} charge for customer {customer}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          customer: requestBody.customer
      - text: Add price {price} with quantity {quantity} to invoice {invoice} for customer {customer}.
        slots:
          price: requestBody.price
          quantity: requestBody.quantity
          invoice: requestBody.invoice
          customer: requestBody.customer
      - text: Create an invoice item for customer {customer} described as {description}.
        slots:
          customer: requestBody.customer
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/Invoice Items/{invoiceitem}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an invoice item
      effect: write
      questions:
      - How do I change the amount of a pending invoice item?
      - Can I edit an invoice item after its invoice is closed?
      instructions:
      - text: Change the amount of invoice item {invoiceitem} to {amount}.
        slots:
          invoiceitem: path.invoiceitem
          amount: requestBody.amount
      - text: Update the description of invoice item {invoiceitem} to {description}.
        slots:
          invoiceitem: path.invoiceitem
          description: requestBody.description
      method: generated
      generated: '2026-09-26'