Skip to content

Update a tier​

PATCH
/me/tiers/{tier_id}

Partial update of one of the caller's tiers. Changing a price mints a new Stripe Price and deactivates the old one; existing subscribers keep their original price until renewal. Setting annual_amount_cents to null withdraws annual billing. Currency cannot be changed. A tier that is not the caller's is a 404.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Path Parameters

tier_id*
Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
{
"name": "string",
"description": "string",
"amount_cents": 0,
"annual_amount_cents": 0,
"benefits": [
"string"
],
"cover_image": "string",
"sort_order": 0,
"subscriber_limit": 0
}

Responses​

Updated tier

application/json
JSON
{
"data": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress