Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Payment Attempts API

3 actions 3 updates phrasing extends openapi/clerk-com-payment-attempts-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 3

$.info
$.paths['/v1/me/billing/payment_attempts'].get
$.paths['/v1/me/billing/payment_attempts/{paymentAttemptID}'].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 Clerk Frontend Payment Attempts API
  version: 1.0.0
extends: openapi/clerk-com-payment-attempts-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['/v1/me/billing/payment_attempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my payment attempts
      effect: read
      questions:
      - Which charges have been attempted on my account?
      - Can I page through every payment attempt made for my billing?
      instructions:
      - text: List my payment attempts.
      - text: Show the payment history on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/payment_attempts/{paymentAttemptID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my payment attempts
      effect: read
      questions:
      - Why did a particular payment on my account fail?
      - What are the details of one payment attempt?
      instructions:
      - text: Get payment attempt {paymentAttemptID}.
        slots:
          paymentAttemptID: path.paymentAttemptID
      - text: Show details of my charge {paymentAttemptID}.
        slots:
          paymentAttemptID: path.paymentAttemptID
      method: generated
      generated: '2026-09-26'