Get the default payment method for a customer

Returns the customer’s default card for the authenticated provider. Sourced from stored payment-method records (no Stripe round-trip). Returns { kind: 'none' } when no card is on file.

GET /v1/sdk/payment-method

Get the default payment method for a customer

cURL

curl --request GET \
  --url https://api.example.com/v1/sdk/payment-method

200

{
  "brand": "visa",
  "expMonth": 12,
  "expYear": 2030,
  "last4": "4242"
}

Query Parameters

customerRef · string · required

Customer reference (e.g. customer_...).

Response

200 - application/json

The customer's default card, or { kind: 'none' } when no card is on file.

Option 1

Option 2

brand · string · required

Example:

"visa"

expMonth · integer · required

Required range: 1 <= x <= 12

Example:

12

expYear · integer · required

Example:

2030

kind · enum<string> · required

Available options: card

last4 · string · required

Example:

"4242"