StoreBay Developers
Products pricing

Update a rate plan

PATCH
/rate-plans/{id}

Authorization

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

Path Parameters

id*string

UUIDv7 identifier of the resource.

Formatuuid

Header Parameters

Idempotency-Key?string

A unique key that makes this mutation safe to retry. Repeats replay the stored response; reuse with a different body returns 409 idempotency_conflict.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

All fields optional; only supplied fields are changed.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rate-plans/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}
{  "error": {    "code": "unauthorized",    "message": "Missing or invalid credential."  }}
{  "error": {    "code": "insufficient_scope",    "message": "The credential lacks a scope required by this endpoint."  }}
{  "error": {    "code": "not_found",    "message": "Resource not found."  }}
{  "error": {    "code": "conflict",    "message": "The request conflicts with current resource state."  }}
{  "error": {    "code": "validation_error",    "message": "One or more fields are invalid.",    "details": [      {        "field": "email",        "issue": "must be a valid email address"      }    ]  }}
{  "error": {    "code": "rate_limited",    "message": "Rate limit exceeded. Retry after 7s."  }}
{  "error": {    "code": "validation_error",    "message": "string",    "details": [      {        "field": "string",        "issue": "string"      }    ]  }}

Update a product PATCH

Previous Page

Liveness probe GET

Unauthenticated liveness/health check (`GET /v1/health`). Returns 200 with a minimal status document whenever the API process is serving requests. It does no tenant work, requires no credential (note the empty `security` below), and is safe to poll. It backs the deploy health-gate, `scripts/smoke.sh`, Caddy, and the Uptime Kuma status page — NOT a deep dependency (DB/provider) check.