Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Subscriptions API

3 actions 3 updates phrasing extends openapi/clerk-com-subscriptions-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/subscription'].get
$.paths['/v1/organizations/{organizationID}/billing/subscription'].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 Subscriptions API
  version: 1.0.0
extends: openapi/clerk-com-subscriptions-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/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my main billing subscription
      effect: read
      questions:
      - What plan am I currently subscribed to?
      - How does the frontend show the signed-in user's own subscription?
      instructions:
      - text: Show my billing subscription.
      - text: Tell me which plan I am on right now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/subscription'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my organization's subscription as a member
      effect: read
      questions:
      - What plan is my organization on, seen from the frontend?
      - How does a member view their organization's current subscription in the browser?
      instructions:
      - text: Show the frontend subscription for organization {organizationID}.
        slots:
          organizationID: path.organizationID
      - text: As a member, get organization {organizationID}'s current plan.
        slots:
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'