Get a plan for a product
Retrieves a single plan by reference or ID within the given product.
Authorizations
Provider secret API key (sk_live_… / sk_test_…) supplied as a Bearer token.
Path Parameters
Product reference or ID
"prd_1A2B3C4D"
Plan reference or ID
"pln_1A2B3C4D"
Response
Plan retrieved successfully
Creation timestamp
Currency code (ISO 4217)
"USD"
Whether the plan is hidden from customer-facing surfaces. When true, the plan does not appear in checkout or the SDK catalog and can only be granted via direct assignment (enterprise plans).
false
Whether the plan is active (derived from status)
true
Plan price in cents
2999
Plan reference
"pln_1A2B3C4D"
Whether payment is required
true
Plan status
"active"
Plan type exposed in SDK
recurring, one-time, usage-based, hybrid "recurring"
Last update timestamp
Access expiry in days
Billing cycle
"monthly"
Billing model
pre-paid, post-paid "pre-paid"
Credits per usage unit (integer, >= 1)
1
Currency symbol (derived from currency)
"$"
Plan description
"Best for teams getting started"
Plan features
Number of free units included
100
Usage limit for the meter
10000
Usage limits
Maximum number of active users
What the plan measures for usage tracking
"requests"
Meter reference for usage-based plans
"mtr_1A2B3C4D"
Plan name
"Starter"
Per-currency price options for this plan
Whether unused units roll over to next period
false
One-time setup fee
500
Tax inclusion behavior for business checkout
auto, inclusive, exclusive Free trial period in days
14