# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Xquik Subscribe API
  version: 1.0.0
extends: openapi/xquik-api-subscribe-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['/api/v1/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a subscription checkout
      effect: write
      questions:
      - How do I start a paid subscription?
      - Can I get a link to manage my billing?
      - Does creating a subscription checkout charge me immediately?
      instructions:
      - text: Create a subscription checkout for the {tier} tier.
        slots:
          tier: requestBody.tier
      - text: Get me a subscription checkout link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my credit balance
      effect: read
      questions:
      - How many credits do I have left?
      - What is my current credit balance?
      instructions:
      - text: Show my credit balance.
      - text: Check how many credits remain on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credits/topup'].post
  update:
    x-apievangelist-phrasing:
      intent: Buy credits through a hosted checkout
      effect: write
      questions:
      - Can I buy more credits through a hosted checkout?
      - Does creating a top-up checkout add credits right away?
      instructions:
      - text: Create a credit top-up checkout for {dollars} dollars.
        slots:
          dollars: requestBody.dollars
      - text: Start a {dollars} dollar credit purchase checkout in locale {locale}.
        slots:
          dollars: requestBody.dollars
          locale: requestBody.locale
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credits/topup/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a credit top-up's billing status
      effect: read
      questions:
      - Did my credit top-up payment succeed?
      - Can I check the billing status of a checkout session?
      instructions:
      - text: Check top-up status for session {session_id}.
        slots:
          session_id: query.session_id
      - text: Tell me whether checkout {session_id} has been paid.
        slots:
          session_id: query.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credits/quick-topup'].post
  update:
    x-apievangelist-phrasing:
      intent: Charge my saved card for credits
      effect: write
      questions:
      - Can I buy credits instantly with my saved card?
      - Is there a one-click credit top-up that skips the checkout page?
      instructions:
      - text: Charge my saved card {dollars} dollars for credits.
        slots:
          dollars: requestBody.dollars
      - text: Quick top-up {dollars} dollars of credits on my card on file.
        slots:
          dollars: requestBody.dollars
      method: generated
      generated: '2026-09-26'