Skip to content

Move a method's monthly gifts to another method​

POST
/me/payment-methods/{id}/move-gifts

Moves every live monthly gift that charges this method onto another
of the caller's saved methods, before removing this one. Each gift's
Stripe subscription charges the new method from its next payment. A
gift whose subscription has already ended is skipped and not counted.
Safe to repeat: a gift already moved no longer charges this method.

The target must be a live method of the caller, not an expired card,
and on the same Stripe customer as the gifts' subscriptions.

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 method the gifts move off (SavedMethod.id).

Type
string
Required
Format
"uuid"

Request Body​

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

Responses​

How many gifts moved.

application/json
JSON
{
"data": {
"moved": 1
}
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress