Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Invoice Invoiceitems API

6 actions 6 updates phrasing extends openapi/stripe-invoiceitems-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 6

$.info
$.paths['/v1/invoiceitems'].get
$.paths['/v1/invoiceitems'].post
$.paths['/v1/invoiceitems/{invoiceitem}'].get
$.paths['/v1/invoiceitems/{invoiceitem}'].post
$.paths['/v1/invoiceitems/{invoiceitem}'].delete

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 Invoice Invoiceitems API
  version: 1.0.0
extends: openapi/stripe-invoiceitems-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/invoiceitems'].get
  update:
    x-apievangelist-phrasing:
      intent: List invoice items
      effect: read
      questions:
      - How do I see the one-off charges I've added to customers' invoices?
      - Can I list only the invoice items that haven't been billed yet?
      - Can I list the items for one customer or one invoice?
      instructions:
      - text: List my recent invoice items.
      - text: List invoice items for customer {customer}.
        slots:
          customer: query.customer
      - text: List the items on invoice {invoice}.
        slots:
          invoice: query.invoice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/invoiceitems'].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, and how many items can it hold?
      - Can I bill an existing price with a quantity instead of a raw amount?
      instructions:
      - text: Add a charge of {amount} {currency} for customer {customer}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          customer: requestBody.customer
      - text: Add {quantity} of price {price} to invoice {invoice} for customer {customer}.
        slots:
          quantity: requestBody.quantity
          price: requestBody.price
          invoice: requestBody.invoice
          customer: requestBody.customer
      - text: Add a {amount} item described as {description} to customer {customer}'s next invoice.
        slots:
          amount: requestBody.amount
          description: requestBody.description
          customer: requestBody.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/invoiceitems/{invoiceitem}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an invoice item
      effect: read
      questions:
      - How do I see the details of one invoice item?
      - Has a particular invoice item been billed yet?
      instructions:
      - text: Get invoice item {invoiceitem}.
        slots:
          invoiceitem: path.invoiceitem
      - text: Show me the amount and invoice of item {invoiceitem}.
        slots:
          invoiceitem: path.invoiceitem
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/invoiceitems/{invoiceitem}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an invoice item
      effect: write
      questions:
      - How do I change the amount or description of a charge on an upcoming invoice?
      - Can I still edit an invoice item after its invoice is closed?
      instructions:
      - text: Change 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'
- target: $.paths['/v1/invoiceitems/{invoiceitem}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an invoice item
      effect: destructive
      questions:
      - How do I remove a charge I added to a customer's invoice?
      - Can I delete an invoice item once its invoice is finalized?
      instructions:
      - text: Delete invoice item {invoiceitem}.
        slots:
          invoiceitem: path.invoiceitem
      - text: Remove item {invoiceitem} from its draft invoice.
        slots:
          invoiceitem: path.invoiceitem
      method: generated
      generated: '2026-09-26'