List plans

View as Markdown

Returns a paginated list of plans (products) available in your catalog. Defaults to active plans only.

Authentication

AuthorizationBearer

Use a secret key (sk_test_* or sk_live_*) for full read/write access, or a public key (pk_test_* or pk_live_*) for read-only access.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of items to return (1-100).

offsetintegerOptional>=0Defaults to 0
Number of items to skip before returning results.
statusenumOptionalDefaults to active
Filter by plan status.
Allowed values:

Response

A paginated list of plans
datalist of objects
paginationobject

Errors

401
Unauthorized Error
429
Too Many Requests Error