# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign REST Billing Plans API
  version: 1.0.0
extends: openapi/docusign-billing-plans-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/accounts/{accountId}/billing_plan'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account's current billing plan
      effect: read
      questions:
      - What billing plan is my account on, and what can it upgrade to?
      - Can I leave the credit card details out of the billing plan response?
      instructions:
      - text: Get the billing plan for account {account}.
        slots:
          account: path.accountId
      - text: Show account {account}'s billing plan including successor plans.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/billing_plan'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an account's billing plan or payment details
      effect: write
      questions:
      - How do I switch my account to a different billing plan?
      - Can I update the billing address or credit card on file?
      - Is there a way to preview a plan change before committing?
      instructions:
      - text: Change account {account} to billing plan {plan}.
        slots:
          account: path.accountId
          plan: requestBody.planInformation
      - text: Update the billing address of account {account} to {address}.
        slots:
          account: path.accountId
          address: requestBody.billingAddress
      - text: Replace the credit card on account {account} with {card}.
        slots:
          account: path.accountId
          card: requestBody.creditCardInformation
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/billing_plan/credit_card'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the credit card on file
      effect: read
      questions:
      - Which credit card is on file for my account?
      - Can I check the expiry metadata of the card we pay with?
      instructions:
      - text: Get the credit card metadata for account {account}.
        slots:
          account: path.accountId
      - text: Show the payment card stored on account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/billing_plan/purchased_envelopes'].put
  update:
    x-apievangelist-phrasing:
      intent: Purchase additional envelopes (internal use)
      effect: write
      questions:
      - Can I buy extra envelopes for my account through the API?
      - Is the envelope purchase endpoint open to external integrators?
      instructions:
      - text: Purchase {quantity} additional envelopes for account {account}.
        slots:
          quantity: requestBody.quantity
          account: path.accountId
      - text: Complete an envelope purchase of {amount} {currency} for account {account}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currencyCode
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/billing_plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List available billing plans
      effect: read
      questions:
      - What billing plans are available from my distributor?
      - Which plans could a new account be signed up for?
      instructions:
      - text: List all available billing plans.
      - text: Show the billing plans offered by my distributor.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/billing_plans/{billingPlanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of a specific billing plan
      effect: read
      questions:
      - What's included in a particular billing plan?
      - Can I look up a billing plan's pricing by its plan ID?
      instructions:
      - text: Get details for billing plan {plan}.
        slots:
          plan: path.billingPlanId
      - text: Show what billing plan {plan} includes.
        slots:
          plan: path.billingPlanId
      method: generated
      generated: '2026-10-01'