Payment methods
Save, retrieve, and detach reusable payment methods.
A payment method stores reusable card or bank details attached to a customer. Save a payment method
once and reference its pm_ ID on any future payment or subscription — no need to re-collect card
details.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The payment method objectAsk
idstringUnique identifier for the payment method, e.g. pm_9bR3.
typestringThe instrument type. Currently card; additional types (e.g. sepa_debit) are roadmap items.
cardobjectPresent when type is card.
billing_detailsobjectBilling contact associated with this payment method.
customerobjectExpandableThe customer this payment method is attached to, if any. Expand to retrieve the full object.
createdintegerUnix timestamp when the payment method was created.
Create a payment methodAsk
Pass type and the card credentials. After creating, attach the method to a customer by updating
the customer's default_payment_method or referencing the pm_ ID directly on a payment.
Retrieve a payment methodAsk
Update a payment methodAsk
Only billing_details fields can be updated on an existing payment method. Card credentials are
immutable — create a new payment method to change the card.
Detach a payment methodAsk
Removes the payment method from its customer. The object is retained but can no longer be used for new charges.
List payment methodsAsk
Returns all payment methods attached to a customer. Filter by type to narrow results.
Related eventsAsk
payment_method.created, payment_method.updated, payment_method.detached. See Events.
