Saved payment methods

Saved payment method entities hold information about a payment method a customer has saved. They're related to customer entities.

When customers sign up for a subscription, Paddle automatically creates a saved payment method entity for future charges for that subscription. Customers can also choose to save a payment method at checkout when purchasing one-time items.

Saved payment method entities hold information about a saved payment method. They include information like:

The kind of payment method saved.
The address that a payment method uses.
Information about the payment method, like the card details or email address for PayPal.
How and when a payment method was saved.

Saved payment methods can be retrieved and deleted using the Paddle API, but can't be created using the API. Use Paddle.js to handle securely saving payment methods and presenting them to customers.

Payment methods

Present saved payment methods at checkout

Attributes

idstring

Unique Paddle ID for this payment method entity, prefixed with paymtd_.

customer_idstring

Paddle ID of the customer that this payment method is saved for, prefixed with ctm_.

address_idstring

Paddle ID of the address for this payment method, prefixed with add_.

typestring

Type of payment method saved.

cardobject or null

Information about the credit or debit card saved. null unless type is card.

typestring

Type of credit or debit card used to pay.

last4string

Last four digits of the card used to pay.

expiry_monthnumber

Month of the expiry date of the card used to pay.

expiry_yearnumber

Year of the expiry date of the card used to pay.

cardholder_namestring

The name on the card used to pay.

paypalobject or null

Information about the PayPal payment method saved. null unless type is paypal.

emailstring

Email address associated with the PayPal account.

referencestring

PayPal payment method identifier.

originstring

Describes how this payment method was saved.

saved_atstring<date-time>

RFC 3339 datetime string of when this entity was saved. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

List payment methods for a customer

gethttps://api.paddle.com/customers/{customer_id}/payment-methods

Get a payment method for a customer

gethttps://api.paddle.com/customers/{customer_id}/payment-methods/{payment_method_id}

Delete a payment method for a customer

deletehttps://api.paddle.com/customers/{customer_id}/payment-methods/{payment_method_id}