AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Billing API

13 actions 13 updates phrasing extends openapi/aiapplyd-billing-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AI Applyd's API. It is a proposal applied on top of the contract, not a document AI Applyd publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/billing/create-checkout-session'].post
$.paths['/billing/create-portal-session'].post
$.paths['/billing/sync-after-checkout'].post
$.paths['/billing/subscription'].get
$.paths['/billing/cancel-subscription'].post
$.paths['/billing/subscription/switch'].post
$.paths['/billing/invoices'].get
$.paths['/billing/usage'].get
$.paths['/billing/action-costs'].get
$.paths['/native-billing/bootstrap'].post
$.paths['/billing/native/verify'].post
$.paths['/native-billing/purchases/accept'].post

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 Aiapplyd Billing API
  version: 1.0.0
extends: openapi/aiapplyd-billing-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: 12
- target: $.paths['/billing/create-checkout-session'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a checkout for a plan or token pack
      effect: write
      questions:
      - How do I subscribe or buy a token pack with a card?
      - Can I choose monthly or yearly billing at checkout?
      instructions:
      - text: Create a checkout session for price {priceId}.
        slots:
          priceId: requestBody.priceId
      - text: Start checkout for {priceId} billed {interval}.
        slots:
          priceId: requestBody.priceId
          interval: requestBody.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/create-portal-session'].post
  update:
    x-apievangelist-phrasing:
      intent: Open the billing portal
      effect: write
      questions:
      - Where can I update my payment method or manage my subscription?
      - Can I get a link to the self-service billing portal?
      instructions:
      - text: Open my billing portal.
      - text: Create a billing portal session that returns to {returnUrl}.
        slots:
          returnUrl: requestBody.returnUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/sync-after-checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync my subscription after checkout
      effect: write
      questions:
      - My payment went through but my plan hasn't updated, what can refresh it?
      - What syncs subscription data after a successful checkout?
      instructions:
      - text: Sync my subscription after checkout.
      - text: Refresh my plan now that payment succeeded.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my subscription and token balance
      effect: read
      questions:
      - What plan am I on and how many tokens do I have left?
      - When does my current subscription renew?
      instructions:
      - text: Show my subscription details.
      - text: Tell me my current token balance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/cancel-subscription'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel my subscription
      effect: destructive
      questions:
      - Can I cancel my subscription at the end of the billing period instead of right away?
      - How do I cancel my plan immediately?
      instructions:
      - text: Cancel my subscription at the end of the period.
      - text: 'Cancel my subscription now with reason {reason}: {cancelImmediately}.'
        slots:
          reason: requestBody.reason
          cancelImmediately: requestBody.cancelImmediately
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/subscription/switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch to a different plan
      effect: write
      questions:
      - Can I upgrade my plan and pay the prorated difference?
      - When does a downgrade take effect?
      instructions:
      - text: Switch my plan to {newPriceId}.
        slots:
          newPriceId: requestBody.newPriceId
      - text: Change my subscription to {newPriceId} billed {interval}.
        slots:
          newPriceId: requestBody.newPriceId
          interval: requestBody.interval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List my invoices
      effect: read
      questions:
      - Where can I find my past invoices?
      - Can I page through my invoice history?
      instructions:
      - text: List my invoices.
      - text: Show {limit} invoices after {startingAfter}.
        slots:
          limit: query.limit
          startingAfter: query.startingAfter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Check per-action usage and limits
      effect: read
      questions:
      - How much of each action's quota have I used?
      - Which AI actions am I close to the limit on?
      instructions:
      - text: Show my action usage and remaining quota.
      - text: List my per-action limits.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/action-costs'].get
  update:
    x-apievangelist-phrasing:
      intent: See estimated token cost per AI action
      effect: read
      questions:
      - How many tokens does each AI action typically cost?
      - What's the maximum token cost of tailoring a resume?
      instructions:
      - text: List the token cost estimates for every AI action.
      - text: Show min, typical and max token costs per action.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/native-billing/bootstrap'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the native app billing catalog
      effect: read
      questions:
      - What products are available for in-app purchase on mobile?
      - Which store account binding does the native app use for purchases?
      instructions:
      - text: Get the native billing bootstrap.
      - text: Load the in-app product catalog and store binding.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/native/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify an in-app store purchase
      effect: write
      questions:
      - How is an in-app purchase checked and turned into an entitlement?
      - My mobile purchase went through, can it be verified with the store?
      instructions:
      - text: Verify my native store purchase.
      - text: Check my app store purchase and grant the entitlement.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/native-billing/purchases/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Settle a verified in-app token pack
      effect: write
      questions:
      - Will tokens from an in-app token pack be credited only once?
      - How do verified mobile token pack purchases get added to my balance?
      instructions:
      - text: Accept my verified token pack purchase.
      - text: Credit the tokens from my in-app pack purchase.
      method: generated
      generated: '2026-09-26'