Skip to main content
GET
cURL
Reads the current, non-archived plan with the supplied stable id in the environment selected by your API key. The response is the plan item itself, including its monthly credit allowance, price in USD cents, and Stripe sync status when paid. An unknown or archived ID returns 404 not_found. Changed plans create a new current version, so this endpoint may return different values after Update a plan; existing subscriptions keep their earlier referenced version. Use List active plans to discover current IDs. See Catalog for plan lifecycle details.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$

Response

Active Plan

id
string
required
Required string length: 1 - 100
Pattern: ^[a-zA-Z0-9_-]+$
name
string
required
Required string length: 1 - 120
monthlyCredits
integer
required
Required range: x <= 2147483647
monthlyPriceCents
integer
required
Required range: 0 <= x <= 2147483647
stripeSyncStatus
enum<string> | null
Available options:
pending,
synced,
failed,
null