Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Subscription Items API

5 actions 5 updates phrasing extends openapi/clerk-com-subscription-items-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 5

$.info

$.paths['/v1/me/billing/subscription_items'].get

$.paths['/v1/me/billing/subscription_items/{subscriptionItemID}'].delete

$.paths['/v1/organizations/{organizationID}/billing/subscription_items'].get

$.paths['/v1/organizations/{organizationID}/billing/subscription_items/{subscriptionItemID}'].delete

OpenAPI Overlay

# 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 Subscription Items API
  version: 1.0.0
extends: openapi/clerk-com-subscription-items-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/me/billing/subscription_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List my subscription items
      effect: read
      questions:
      - Which plans am I currently subscribed to?
      - Can I page through my personal subscription items?
      instructions:
      - text: List my subscription items.
      - text: Show the plans I'm personally subscribed to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/billing/subscription_items/{subscriptionItemID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel one of my subscription items
      effect: destructive
      questions:
      - How do I cancel my personal subscription to a plan?
      - Can I cancel a single subscription item without closing my account?
      instructions:
      - text: Cancel my subscription item {subscriptionItemID}.
        slots:
          subscriptionItemID: path.subscriptionItemID
      - text: Stop my personal plan subscription {subscriptionItemID}.
        slots:
          subscriptionItemID: path.subscriptionItemID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/subscription_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's subscription items
      effect: read
      questions:
      - Which plans is our organization subscribed to?
      - Can I see an organization's active subscription items?
      instructions:
      - text: List subscription items for organization {organizationID}.
        slots:
          organizationID: path.organizationID
      - text: Show the plans org {organizationID} pays for.
        slots:
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationID}/billing/subscription_items/{subscriptionItemID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an organization's subscription item
      effect: destructive
      questions:
      - How do I cancel a plan my organization is subscribed to?
      - Can one organization subscription item be canceled on its own?
      instructions:
      - text: Cancel subscription item {subscriptionItemID} for organization {organizationID}.
        slots:
          subscriptionItemID: path.subscriptionItemID
          organizationID: path.organizationID
      - text: Stop org {organizationID}'s plan subscription {subscriptionItemID}.
        slots:
          subscriptionItemID: path.subscriptionItemID
          organizationID: path.organizationID
      method: generated
      generated: '2026-09-26'