Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Billing API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/billing/checkout'].post
$.paths['/v1/billing/usdc/intent'].post
$.paths['/v1/billing/square/webhook'].post
$.paths['/v1/billing/tenant/{tenant_id}'].get

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 Thehiveryiq Com Billing API
  version: 1.0.0
extends: openapi/thehiveryiq-com-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: 4
- target: $.paths['/v1/billing/checkout'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a card checkout link for a tier
      effect: write
      questions:
      - How do I get a payment link so a tenant can pay for a subscription tier by card?
      - What happens if the card processor is unreachable when creating a checkout link?
      instructions:
      - text: Create a checkout link for tenant {tenant_id} on tier {tier} billed to {email}.
        slots:
          tenant_id: requestBody.tenant_id
          tier: requestBody.tier
          email: requestBody.email
      - text: Send {email} a card payment link for the {tier} plan for {tenant_id}.
        slots:
          email: requestBody.email
          tier: requestBody.tier
          tenant_id: requestBody.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/usdc/intent'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a USDC-on-Base payment intent for a tier
      effect: write
      questions:
      - Can a tenant pay for a plan in USDC on Base instead of by card?
      - What treasury address and expiry come back with a USDC billing intent?
      instructions:
      - text: Create a USDC payment intent for tenant {tenant_id} on tier {tier}.
        slots:
          tenant_id: requestBody.tenant_id
          tier: requestBody.tier
      - text: Generate USDC billing instructions for {tenant_id} upgrading to {tier}.
        slots:
          tenant_id: requestBody.tenant_id
          tier: requestBody.tier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/square/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive card payment webhooks
      effect: write
      questions:
      - Which payment events activate a tenant automatically?
      - Are incoming payment webhooks signature-verified?
      instructions:
      - text: Deliver a payment.updated webhook to activate the tenant.
      - text: Post an invoice.payment_made event to the billing webhook receiver.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/billing/tenant/{tenant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's billing state
      effect: read
      questions:
      - Is a tenant's subscription active and on which tier?
      - Can I check billing status for one tenant?
      instructions:
      - text: Get billing state for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Check whether {tenant_id} is active.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'