# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Customers API
  version: 1.0.0
extends: openapi/stripe-customers-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: 47
- target: $.paths['/v1/customers'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers
      effect: read
      questions:
      - How do I pull a list of all my customers, newest first?
      - Can I look up customers by email address when listing them?
      - Can I filter my customer list to people created in a certain date range?
      instructions:
      - text: List my most recent customers.
      - text: List customers with the email {email}.
        slots:
          email: query.email
      - text: Show me the first {limit} customers on my account.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a customer
      effect: write
      questions:
      - How do I add a new customer record in Stripe?
      - Can I attach a payment method when I create a customer?
      - Can I give a new customer a starting credit balance?
      instructions:
      - text: Create a customer named {name} with email {email}.
        slots:
          name: requestBody.name
          email: requestBody.email
      - text: Add a new customer with phone number {phone}.
        slots:
          phone: requestBody.phone
      - text: Create a customer and attach payment method {payment_method}.
        slots:
          payment_method: requestBody.payment_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search customers with a query
      effect: read
      questions:
      - How do I search my customers by name, email or metadata?
      - Is customer search safe to use right after I create a customer?
      - Can I page through a large set of customer search results?
      instructions:
      - text: Search customers matching {query}.
        slots:
          query: query.query
      - text: Find customers where {query} and return the next page {page}.
        slots:
          query: query.query
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer
      effect: read
      questions:
      - How do I fetch the full details of one customer?
      - What information comes back when I look up a single customer?
      instructions:
      - text: Get customer {customer}.
        slots:
          customer: path.customer
      - text: Show me the details on file for customer {customer}.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's details
      effect: write
      questions:
      - How do I change a customer's email or address?
      - Can I set a different default payment source for an existing customer?
      - Do fields I leave out of a customer update get cleared?
      instructions:
      - text: Change the email of customer {customer} to {email}.
        slots:
          customer: path.customer
          email: requestBody.email
      - text: Update customer {customer}'s name to {name}.
        slots:
          customer: path.customer
          name: requestBody.name
      - text: Set the default source of customer {customer} to {default_source}.
        slots:
          customer: path.customer
          default_source: requestBody.default_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a customer
      effect: destructive
      questions:
      - How do I permanently remove a customer?
      - What happens to a customer's active subscriptions when I delete them?
      instructions:
      - text: Delete customer {customer} permanently.
        slots:
          customer: path.customer
      - text: Remove customer {customer} and cancel their active subscriptions.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/balance_transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's credit balance changes
      effect: read
      questions:
      - How do I see every change made to a customer's credit balance?
      - Where can I audit credits and debits applied to a customer's account balance?
      instructions:
      - text: List the balance transactions for customer {customer}.
        slots:
          customer: path.customer
      - text: Show the last {limit} credit balance changes for customer {customer}.
        slots:
          limit: query.limit
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/balance_transactions'].post
  update:
    x-apievangelist-phrasing:
      intent: Adjust a customer's credit balance
      effect: write
      questions:
      - How do I give a customer account credit?
      - Can I change a credit balance transaction after I create it?
      instructions:
      - text: Credit customer {customer} with {amount} in {currency}.
        slots:
          customer: path.customer
          amount: requestBody.amount
          currency: requestBody.currency
      - text: Add a balance adjustment of {amount} {currency} to customer {customer} noting {description}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          customer: path.customer
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/balance_transactions/{transaction}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one customer balance transaction
      effect: read
      questions:
      - How do I look up a single credit balance adjustment for a customer?
      - Can I see the details of one specific customer balance change?
      instructions:
      - text: Get balance transaction {transaction} for customer {customer}.
        slots:
          transaction: path.transaction
          customer: path.customer
      - text: Show me credit adjustment {transaction} on customer {customer}.
        slots:
          transaction: path.transaction
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/balance_transactions/{transaction}'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer balance transaction's note
      effect: write
      questions:
      - Which fields of a customer balance transaction can I still edit?
      - Can I relabel a credit adjustment with a better description?
      instructions:
      - text: Change the description of balance transaction {transaction} on customer {customer} to {description}.
        slots:
          transaction: path.transaction
          customer: path.customer
          description: requestBody.description
      - text: Update the metadata on customer {customer}'s balance transaction {transaction}.
        slots:
          customer: path.customer
          transaction: path.transaction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's bank accounts
      effect: read
      questions:
      - How do I see which bank accounts a customer has saved?
      - Are all of a customer's bank accounts shown on the customer record?
      instructions:
      - text: List the bank accounts saved for customer {customer}.
        slots:
          customer: path.customer
      - text: Show up to {limit} bank accounts belonging to customer {customer}.
        slots:
          limit: query.limit
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bank account to a customer
      effect: write
      questions:
      - How do I save a bank account on a customer from a token?
      - Does adding a bank account to a customer make it their default?
      instructions:
      - text: Attach bank account token {bank_account} to customer {customer}.
        slots:
          bank_account: requestBody.bank_account
          customer: path.customer
      - text: Save a new bank account for customer {customer} using source {source}.
        slots:
          customer: path.customer
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's bank account
      effect: read
      questions:
      - How do I get the details of one bank account a customer saved?
      - Can I look up a customer's older bank account that isn't in the recent list?
      instructions:
      - text: Get bank account {id} for customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Show me customer {customer}'s bank account {id}.
        slots:
          customer: path.customer
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's bank account
      effect: write
      questions:
      - How do I fix the account holder name on a customer's bank account?
      - Can I change whether a saved bank account belongs to an individual or a company?
      instructions:
      - text: Set the account holder name on bank account {id} for customer {customer} to {account_holder_name}.
        slots:
          id: path.id
          customer: path.customer
          account_holder_name: requestBody.account_holder_name
      - text: Mark bank account {id} of customer {customer} as holder type {account_holder_type}.
        slots:
          id: path.id
          customer: path.customer
          account_holder_type: requestBody.account_holder_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer's bank account
      effect: destructive
      questions:
      - How do I delete a bank account a customer no longer uses?
      - Can I detach a saved bank account from a customer?
      instructions:
      - text: Delete bank account {id} from customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Remove customer {customer}'s saved bank account {id}.
        slots:
          customer: path.customer
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/bank_accounts/{id}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a customer's bank account
      effect: write
      questions:
      - How do I verify a customer's bank account with the micro-deposit amounts?
      - What do I need to confirm a customer's bank account before charging it?
      instructions:
      - text: Verify bank account {id} for customer {customer} with deposit amounts {amounts}.
        slots:
          id: path.id
          customer: path.customer
          amounts: requestBody.amounts
      - text: Confirm customer {customer}'s bank account {id} using the two micro-deposits {amounts}.
        slots:
          customer: path.customer
          id: path.id
          amounts: requestBody.amounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cards'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's cards
      effect: read
      questions:
      - How do I list every card a customer has saved?
      - Can I get more than the ten most recent cards for a customer?
      instructions:
      - text: List the cards on file for customer {customer}.
        slots:
          customer: path.customer
      - text: Show {limit} saved cards for customer {customer}.
        slots:
          limit: query.limit
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cards'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a card to a customer
      effect: write
      questions:
      - How do I save a new card on a customer?
      - Does a new card become the default if the customer has none?
      instructions:
      - text: Add card {card} to customer {customer}.
        slots:
          card: requestBody.card
          customer: path.customer
      - text: Save the card from token {source} on customer {customer}.
        slots:
          source: requestBody.source
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's card
      effect: read
      questions:
      - How do I get details about one specific card a customer saved?
      - Can I look up a customer's card by its ID?
      instructions:
      - text: Get card {id} for customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Show me the saved card {id} on customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cards/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's card
      effect: write
      questions:
      - How do I update the expiry date on a customer's saved card?
      - Can I change the billing address on a card a customer already saved?
      instructions:
      - text: Update card {id} on customer {customer} to expire {exp_month}/{exp_year}.
        slots:
          id: path.id
          customer: path.customer
          exp_month: requestBody.exp_month
          exp_year: requestBody.exp_year
      - text: Set the billing ZIP of customer {customer}'s card {id} to {address_zip}.
        slots:
          customer: path.customer
          id: path.id
          address_zip: requestBody.address_zip
      - text: Change the cardholder name on card {id} for customer {customer} to {name}.
        slots:
          id: path.id
          customer: path.customer
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cards/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer's card
      effect: destructive
      questions:
      - How do I delete a card from a customer's account?
      - Can I remove an expired card a customer no longer uses?
      instructions:
      - text: Delete card {id} from customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Remove the saved card {id} on customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cash_balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's cash balance
      effect: read
      questions:
      - How much cash balance does a customer currently hold?
      - Where do I check funds a customer has sent by bank transfer?
      instructions:
      - text: Get the cash balance for customer {customer}.
        slots:
          customer: path.customer
      - text: Show how much unapplied cash customer {customer} has.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cash_balance'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a customer's cash balance settings
      effect: write
      questions:
      - How do I control how a customer's cash balance gets applied to payments?
      - Can I change the reconciliation settings on a customer's cash balance?
      instructions:
      - text: Update the cash balance settings of customer {customer} to {settings}.
        slots:
          customer: path.customer
          settings: requestBody.settings
      - text: Switch customer {customer}'s cash balance reconciliation using settings {settings}.
        slots:
          customer: path.customer
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cash_balance_transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's cash balance activity
      effect: read
      questions:
      - How do I see the history of funds added to or applied from a customer's cash balance?
      - Can I list every change to a customer's cash balance?
      instructions:
      - text: List cash balance transactions for customer {customer}.
        slots:
          customer: path.customer
      - text: Show the latest {limit} cash balance movements for customer {customer}.
        slots:
          limit: query.limit
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/cash_balance_transactions/{transaction}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one cash balance transaction
      effect: read
      questions:
      - How do I look up one specific movement on a customer's cash balance?
      - Can I see what a single cash balance transaction was applied to?
      instructions:
      - text: Get cash balance transaction {transaction} for customer {customer}.
        slots:
          transaction: path.transaction
          customer: path.customer
      - text: Show me cash movement {transaction} on customer {customer}'s balance.
        slots:
          transaction: path.transaction
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/discount'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's discount
      effect: read
      questions:
      - How do I check which discount is applied to a customer?
      - Does this customer currently have a coupon applied?
      instructions:
      - text: Get the discount applied to customer {customer}.
        slots:
          customer: path.customer
      - text: Show the active coupon discount on customer {customer}.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/discount'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer's discount
      effect: destructive
      questions:
      - How do I take a discount off a customer?
      - Can I end a coupon that's applied to a customer's account?
      instructions:
      - text: Remove the discount from customer {customer}.
        slots:
          customer: path.customer
      - text: Delete the coupon currently applied to customer {customer}.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/funding_instructions'].post
  update:
    x-apievangelist-phrasing:
      intent: Get bank transfer instructions for a customer
      effect: write
      questions:
      - How do I give a customer bank details to fund their cash balance?
      - Which currency can I request bank transfer funding instructions in?
      instructions:
      - text: Get bank transfer funding instructions for customer {customer} in {currency}.
        slots:
          customer: path.customer
          currency: requestBody.currency
      - text: Create funding instructions of type {funding_type} for customer {customer}.
        slots:
          funding_type: requestBody.funding_type
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/payment_methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's payment methods
      effect: read
      questions:
      - How do I see every payment method saved for a customer?
      - Can I list only a customer's cards or only one payment method type?
      instructions:
      - text: List payment methods for customer {customer}.
        slots:
          customer: path.customer
      - text: Show customer {customer}'s saved payment methods of type {type}.
        slots:
          customer: path.customer
          type: query.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/payment_methods/{payment_method}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's payment method
      effect: read
      questions:
      - How do I get a specific PaymentMethod belonging to a customer?
      - Can I confirm a PaymentMethod actually belongs to a given customer?
      instructions:
      - text: Get payment method {payment_method} for customer {customer}.
        slots:
          payment_method: path.payment_method
          customer: path.customer
      - text: Check PaymentMethod {payment_method} on customer {customer}.
        slots:
          payment_method: path.payment_method
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's payment sources
      effect: read
      questions:
      - How do I list all the payment sources on a customer?
      - Can I list only one kind of source, like bank accounts, for a customer?
      instructions:
      - text: List payment sources for customer {customer}.
        slots:
          customer: path.customer
      - text: Show customer {customer}'s sources of object type {object}.
        slots:
          customer: path.customer
          object: query.object
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a payment source to a customer
      effect: write
      questions:
      - How do I attach a source or token to an existing customer?
      - What happens to the default source when I attach a new one?
      instructions:
      - text: Attach source {source} to customer {customer}.
        slots:
          source: requestBody.source
          customer: path.customer
      - text: Add a payment source to customer {customer} with metadata {metadata}.
        slots:
          customer: path.customer
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's payment source
      effect: read
      questions:
      - How do I fetch one payment source attached to a customer?
      - Can I look up any source on a customer, not just cards?
      instructions:
      - text: Get source {id} for customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Show payment source {id} attached to customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a customer's payment source
      effect: write
      questions:
      - How do I update the owner details on a customer's payment source?
      - Can I change the billing address stored on a customer's source?
      instructions:
      - text: Update the owner of source {id} on customer {customer} to {owner}.
        slots:
          id: path.id
          customer: path.customer
          owner: requestBody.owner
      - text: Set the billing country of customer {customer}'s source {id} to {address_country}.
        slots:
          customer: path.customer
          id: path.id
          address_country: requestBody.address_country
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a customer's payment source
      effect: destructive
      questions:
      - How do I detach a payment source from a customer?
      - Can I remove any kind of saved source from a customer, not only cards?
      instructions:
      - text: Detach source {id} from customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Delete payment source {id} belonging to customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/sources/{id}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a customer's bank source
      effect: write
      questions:
      - How do I verify a bank account source using micro-deposits?
      - What amounts do I send to verify a customer's bank source?
      instructions:
      - text: Verify source {id} on customer {customer} with amounts {amounts}.
        slots:
          id: path.id
          customer: path.customer
          amounts: requestBody.amounts
      - text: Complete micro-deposit verification of source {id} for customer {customer} using {amounts}.
        slots:
          id: path.id
          customer: path.customer
          amounts: requestBody.amounts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's subscriptions
      effect: read
      questions:
      - How do I see which active subscriptions a customer has?
      - Can I list more than the ten subscriptions shown on the customer?
      instructions:
      - text: List active subscriptions for customer {customer}.
        slots:
          customer: path.customer
      - text: Show {limit} of customer {customer}'s subscriptions.
        slots:
          limit: query.limit
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a customer to a plan
      effect: write
      questions:
      - How do I start a subscription for an existing customer?
      - Can I give a customer a free trial when I subscribe them?
      - Can I apply a promotion code to a new subscription?
      instructions:
      - text: Subscribe customer {customer} to items {items}.
        slots:
          customer: path.customer
          items: requestBody.items
      - text: Start a subscription for customer {customer} with a {trial_period_days}-day trial on {items}.
        slots:
          customer: path.customer
          trial_period_days: requestBody.trial_period_days
          items: requestBody.items
      - text: Create a subscription for customer {customer} using promotion code {promotion_code} on {items}.
        slots:
          customer: path.customer
          promotion_code: requestBody.promotion_code
          items: requestBody.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions/{subscription_exposed_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's subscription
      effect: read
      questions:
      - How do I look up one subscription belonging to a customer?
      - Can I check a customer's subscription status by its ID?
      instructions:
      - text: Get subscription {subscription_exposed_id} for customer {customer}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
      - text: Show customer {customer}'s subscription {subscription_exposed_id}.
        slots:
          customer: path.customer
          subscription_exposed_id: path.subscription_exposed_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions/{subscription_exposed_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a customer's subscription
      effect: write
      questions:
      - How do I upgrade or change the plan on a customer's subscription?
      - Can I control proration when I change a customer's subscription?
      - Can I pause payment collection on a subscription?
      instructions:
      - text: Change subscription {subscription_exposed_id} for customer {customer} to items {items}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
          items: requestBody.items
      - text: 'Set customer {customer}''s subscription {subscription_exposed_id} to cancel at period end: {cancel_at_period_end}.'
        slots:
          customer: path.customer
          subscription_exposed_id: path.subscription_exposed_id
          cancel_at_period_end: requestBody.cancel_at_period_end
      - text: Pause collection on subscription {subscription_exposed_id} of customer {customer} with {pause_collection}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
          pause_collection: requestBody.pause_collection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions/{subscription_exposed_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a customer's subscription
      effect: destructive
      questions:
      - How do I cancel a customer's subscription?
      - Can I invoice the customer for pending usage when I cancel their subscription?
      instructions:
      - text: Cancel subscription {subscription_exposed_id} for customer {customer}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
      - text: 'Cancel customer {customer}''s subscription {subscription_exposed_id} and invoice now: {invoice_now}.'
        slots:
          customer: path.customer
          subscription_exposed_id: path.subscription_exposed_id
          invoice_now: requestBody.invoice_now
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a subscription's discount
      effect: read
      questions:
      - How do I see the discount applied to one of a customer's subscriptions?
      - Is there a coupon on this particular subscription?
      instructions:
      - text: Get the discount on subscription {subscription_exposed_id} for customer {customer}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
      - text: Show which coupon applies to customer {customer}'s subscription {subscription_exposed_id}.
        slots:
          customer: path.customer
          subscription_exposed_id: path.subscription_exposed_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a subscription's discount
      effect: destructive
      questions:
      - How do I take a coupon off one of a customer's subscriptions?
      - Can I remove a discount from a subscription without touching the customer's other discounts?
      instructions:
      - text: Remove the discount from subscription {subscription_exposed_id} of customer {customer}.
        slots:
          subscription_exposed_id: path.subscription_exposed_id
          customer: path.customer
      - text: Delete the coupon on customer {customer}'s subscription {subscription_exposed_id}.
        slots:
          customer: path.customer
          subscription_exposed_id: path.subscription_exposed_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/tax_ids'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's tax IDs
      effect: read
      questions:
      - How do I see the VAT or tax IDs stored for a customer?
      - Can a customer have more than one tax ID on file?
      instructions:
      - text: List tax IDs for customer {customer}.
        slots:
          customer: path.customer
      - text: Show all tax registration numbers saved on customer {customer}.
        slots:
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/tax_ids'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tax ID to a customer
      effect: write
      questions:
      - How do I add a VAT number to a customer so it shows on invoices?
      - Which tax ID types can I store on a customer?
      instructions:
      - text: Add tax ID {value} of type {type} to customer {customer}.
        slots:
          value: requestBody.value
          type: requestBody.type
          customer: path.customer
      - text: Save {type} number {value} on customer {customer}.
        slots:
          type: requestBody.type
          value: requestBody.value
          customer: path.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/tax_ids/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a customer's tax ID
      effect: read
      questions:
      - How do I look up one tax ID stored on a customer?
      - Can I check the verification status of a customer's tax ID?
      instructions:
      - text: Get tax ID {id} for customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Show customer {customer}'s tax ID record {id}.
        slots:
          customer: path.customer
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/customers/{customer}/tax_ids/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer's tax ID
      effect: destructive
      questions:
      - How do I remove an outdated tax ID from a customer?
      - Can I delete a VAT number I added to a customer by mistake?
      instructions:
      - text: Delete tax ID {id} from customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      - text: Remove the tax registration {id} on customer {customer}.
        slots:
          id: path.id
          customer: path.customer
      method: generated
      generated: '2026-09-26'