Skip to content

Make a saved payment method the default​

PATCH
/me/payment-methods/{id}

Makes one of the caller's live methods their default; the previous
default stops being it. Making the current default the default changes
nothing. An expired card cannot be the default.

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)

Request Body​

application/json
JSON
{
"isDefault": true
}

Responses​

The method, now the default.

application/json
JSON
{
"data": {
"method": "string"
}
}

Playground​

Server
Authorization
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress