Skip to content

Change the method a creator membership charges​

PATCH
/me/subscriptions/{id}

Pays one of the caller's memberships with another of their saved
methods. When the membership's renewal failed (past_due, unpaid)
the open invoice is paid with the new method at once, and payment
says what became of it; a membership that is paid up again loses its
payment_failed_at, failure_code and next_payment_attempt_at.

The method must be a live method of the caller, not an expired card,
and on the same Stripe customer as the membership's subscription; a US
bank account only where the membership already takes bank debits.

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 membership's id (CreatorSubscription.id).

Type
string
Required
Format
"uuid"

Request Body​

application/json
JSON
"string"

Responses​

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

application/json
JSON
{
"data": {
"subscription": "string",
"payment": {
"status": "string",
"failure_code": "string"
}
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress