Skip to content

Change the paid membership plan​

PATCH
/communities/{id}/membership

Owner only. A price change with paying members is scheduled: every paying member is emailed and moves to the new price at their first renewal 30 days or more after the notice; new joiners pay it at once. Paid to free cancels every subscription at period end. Audit-logged, no event.

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

id*

The community's uuid or slug.

Type
string
Required

Request Body​

application/json
JSON
{
"membership": "string",
"price_cents": 0,
"yearly_price_cents": 0,
"perks": [
"string"
],
"leaders_join_free": true
}

Responses​

OK

application/json
JSON
{
"data": {
"membership": "string",
"price_cents": 0,
"yearly_price_cents": 0,
"currency": "string",
"perks": [
"string"
],
"leaders_join_free": true,
"payee_name": "string",
"pending_change": {
"price_cents": 0,
"yearly_price_cents": 0,
"effective_at": "string"
},
"accepting_payments": true,
"fee_preview": {
"gross_cents": 0,
"card_fee_cents": 0,
"fundlyhub_fee_cents": 0,
"net_cents": 0
},
"tax_note": "string",
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress