Skip to content

Stop one of my monthly tips​

POST
/me/platform-tips/{id}/cancel

Stops one of the caller's own monthly tips. It takes effect at once,
like stopping a monthly gift: no further month is charged, and the
months already paid stay as they are (no refund). A tip that has
already ended answers 200 as well, with when it ended.

The caller's own signed-in session only.

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 monthly tip's id (AccountMonthlyTip.id).

Type
string
Required
Format
"uuid"

Responses​

Stopped.

application/json
JSON
{
"data": {
"canceled": true,
"effective": "string",
"endedAt": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress