Skip to main content
A payment method represents a saved payment instrument attached to a customer. Payment methods are created when a customer completes checkout with save_payment_method: true. Use these endpoints to list, retrieve, detach, or set a default method on the customer. Supported types

List payment methods

GET /v1/payment_methods Returns a paginated list of payment methods for a customer.

Query parameters

string
Filter by customer ID. Recommended — without this filter the endpoint returns methods across all customers on your merchant account.
string
Cursor for pagination. Pass the id of the last payment method from the previous page to retrieve the next page.
number
Maximum number of payment methods to return per page.

Response fields

object[]
required
Array of payment method objects.
boolean
required
Whether more payment methods exist beyond this page.

Retrieve a payment method

GET /v1/payment_methods/{id} Retrieves the details of a single payment method.

Path parameters

string
required
The ID of the payment method to retrieve.

Response fields

string
required
Unique payment method identifier.
string
required
ID of the customer this method belongs to.
string
required
Payment method type. One of card, apple_pay, google_pay, bank_invoice.
object
Card details. Present when type is card, apple_pay, or google_pay.
string
required
ISO 8601 timestamp of when the payment method was saved.

Detach a payment method

DELETE /v1/payment_methods/{id} Detaches a payment method from its customer. Once detached, the method can no longer be used for future payments. This action is irreversible.

Path parameters

string
required
The ID of the payment method to detach.

Response fields

string
required
ID of the detached payment method.
boolean
required
Always true on a successful detach response.

Set default payment method

POST /v1/payment_methods/{id}/set_default Sets a payment method as the default for the associated customer. The default method is used automatically for recurring charges and subscription renewals.

Path parameters

string
required
The ID of the payment method to set as default.

Response fields

string
required
Unique payment method identifier.
string
required
ID of the customer this method belongs to.
string
required
Payment method type. One of card, apple_pay, google_pay, bank_invoice.
object
Card details. Present when type is card, apple_pay, or google_pay.
string
required
ISO 8601 timestamp of when the payment method was saved.