Skip to content

Change the method a monthly tip charges​

PATCH
/me/platform-tips/{id}

Pays one of the caller's live monthly tips with another of their saved
methods, from its next charge. The rules are the ones every
subscription shares (see SubscriptionRetry): the method must be a
live method of the caller, not an expired card, and on the same Stripe
customer as the tip's subscription; a US bank account only where the
subscription already takes bank debits. A renewal that failed is paid
with the new method at once.

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"

Request Body​

application/json
JSON
"string"

Responses​

The tip, with its method, and what became of a renewal that was owed.

application/json
JSON
{
"data": {
"tip": "string",
"payment": "string"
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress