Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Billing Agreements API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/v1/billing/agreements'].get
$.paths['/api/v1/billing/agreements'].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 Kinde Management Billing Agreements API
  version: 1.0.0
extends: openapi/kinde-billing-agreements-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: 2
- target: $.paths['/api/v1/billing/agreements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a billing customer's agreements
      effect: read
      questions:
      - Which billing agreements does a customer currently have?
      - Can I filter a customer's agreements by feature code?
      instructions:
      - text: List billing agreements for customer {customer_id}.
        slots:
          customer_id: query.customer_id
      - text: Show customer {customer_id}'s agreements that include feature {feature_code}.
        slots:
          customer_id: query.customer_id
          feature_code: query.feature_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/billing/agreements'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a customer onto a billing plan
      effect: write
      questions:
      - How do I switch a billing customer to a new plan?
      - Does creating an agreement cancel the customer's existing agreements?
      - Can I prorate or invoice immediately when changing plans?
      instructions:
      - text: Put customer {customer_id} on plan {plan_code}.
        slots:
          customer_id: requestBody.customer_id
          plan_code: requestBody.plan_code
      - text: Create a billing agreement for customer {customer_id} on plan {plan_code} and invoice now.
        slots:
          customer_id: requestBody.customer_id
          plan_code: requestBody.plan_code
      method: generated
      generated: '2026-09-26'