Products pricing
List rate plans
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Query Parameters
cursor?string
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
limit?integer
Page size. Values above the maximum are clamped.
Range
1 <= value <= 100Default
25unit_type_id?string
Filter by unit type.
Format
uuidsite_id?string
Filter to a single site.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rate-plans"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "rate_plan", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "unit_type_id": "09feeea8-7692-422e-90f1-4a851084cb1a", "name": "string", "billing_interval": "week", "price_minor": 0, "currency": "str", "min_term_months": 0, "effective_from": "2019-08-24", "effective_to": "2019-08-24", "is_active": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}