Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Payment Methods API

11 actions 11 updates phrasing extends openapi/clerk-com-payment-methods-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v1/me/billing/payment_methods'].get
$.paths['/v1/me/billing/payment_methods'].post
$.paths['/v1/me/billing/payment_methods/initialize'].post
$.paths['/v1/me/billing/payment_methods/{paymentMethodID}'].delete
$.paths['/v1/me/billing/payers/default_payment_method'].put
$.paths['/v1/organizations/{organizationID}/billing/payment_methods'].get
$.paths['/v1/organizations/{organizationID}/billing/payment_methods'].post
$.paths['/v1/organizations/{organizationID}/billing/payment_methods/initialize'].post
$.paths['/v1/organizations/{organizationID}/billing/payment_methods/{paymentMethodID}'].delete
$.paths['/v1/organizations/{organizationID}/billing/payers/default_payment_method'].put

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 Clerk Frontend Payment Methods API
  version: 1.0.0
extends: openapi/clerk-com-payment-methods-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: 10
- target: $.paths['/v1/me/billing/payment_methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List my saved payment methods
      effect: read
      questions:
      - Which cards do I have saved for billing on my account?
      - Can I page through my personal payment methods?
      instructions:
      - text: List my saved payment methods.
      - text: Show my personal billing payment methods, 10 at a time.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/payment_methods'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a payment method to my account
      effect: write
      questions:
      - How do I add a card to my personal billing account?
      - What do I need from the payment gateway to save a new payment method?
      instructions:
      - text: Save payment token {payment_token} from {gateway} to my account.
        slots:
          payment_token: requestBody.payment_token
          gateway: requestBody.gateway
      - text: Add a personal payment method using {gateway} token {payment_token}.
        slots:
          payment_token: requestBody.payment_token
          gateway: requestBody.gateway
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/payment_methods/initialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Start setting up a personal payment method
      effect: write
      questions:
      - How do I begin the card setup flow for my own account?
      - What must happen before I can save a payment method for myself?
      instructions:
      - text: Initialize a payment method setup for me.
      - text: Start the personal card setup process.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/payment_methods/{paymentMethodID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of my payment methods
      effect: destructive
      questions:
      - How do I remove a saved card from my own account?
      - Can I delete a personal payment method I no longer use?
      instructions:
      - text: Delete my payment method {paymentMethodID}.
        slots:
          paymentMethodID: path.paymentMethodID
      - text: Remove saved card {paymentMethodID} from my account.
        slots:
          paymentMethodID: path.paymentMethodID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/payers/default_payment_method'].put
  update:
    x-apievangelist-phrasing:
      intent: Set my default payment method
      effect: write
      questions:
      - How do I choose which of my cards is charged by default?
      - Can I change the default payment method on my personal account?
      instructions:
      - text: Set my default payment method.
      - text: Make a different card the default for my personal billing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/payment_methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's payment methods
      effect: read
      questions:
      - Which payment methods does our organization have on file?
      - Can I see the cards saved for an organization's billing?
      instructions:
      - text: List payment methods for organization {organizationID}.
        slots:
          organizationID: path.organizationID
      - text: Show the saved cards of org {organizationID}.
        slots:
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/payment_methods'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a payment method for an organization
      effect: write
      questions:
      - How do I add a card to my organization's billing?
      - What gateway token is needed to save an organization payment method?
      instructions:
      - text: Save {gateway} token {payment_token} as a payment method for organization {organizationID}.
        slots:
          gateway: requestBody.gateway
          payment_token: requestBody.payment_token
          organizationID: path.organizationID
      - text: Add an org payment method to {organizationID} using token {payment_token} from {gateway}.
        slots:
          gateway: requestBody.gateway
          payment_token: requestBody.payment_token
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/payment_methods/initialize'].post
  update:
    x-apievangelist-phrasing:
      intent: Start setting up an organization payment method
      effect: write
      questions:
      - How do I start the card setup flow for an organization?
      - What begins adding a payment method to an organization's billing?
      instructions:
      - text: Initialize a payment method setup for organization {organizationID}.
        slots:
          organizationID: path.organizationID
      - text: Start the org card setup process for {organizationID}.
        slots:
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/payment_methods/{paymentMethodID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization's payment method
      effect: destructive
      questions:
      - How do I remove a card from my organization's billing?
      - Can an organization's saved payment method be deleted?
      instructions:
      - text: Delete payment method {paymentMethodID} from organization {organizationID}.
        slots:
          paymentMethodID: path.paymentMethodID
          organizationID: path.organizationID
      - text: Remove org card {paymentMethodID} from {organizationID}.
        slots:
          paymentMethodID: path.paymentMethodID
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/payers/default_payment_method'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's default payment method
      effect: write
      questions:
      - How do I pick which card my organization is billed on by default?
      - Can I change an organization's default payment method?
      instructions:
      - text: Make {payment_method_id} the default payment method for organization {organizationID}.
        slots:
          payment_method_id: requestBody.payment_method_id
          organizationID: path.organizationID
      - text: Set org {organizationID} to be billed on card {payment_method_id} by default.
        slots:
          payment_method_id: requestBody.payment_method_id
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'