Set Default Card
PUT/api/customers/:customer/payment-methods/:paymentMethod/default
Make a saved card the customer's default. Clears the default flag on the customer's other cards and sets it on this one.
customers:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (PAT).
Permission: customers.update.
No request body. The card must belong to the customer in the path, otherwise a 422 is returned.
Returns 200 with { data: <card on file>, message: "Default card updated." } (no token field).
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.