Payment Methods
PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.
Related guides: Payment Methods and More Payment Scenarios.
The PaymentMethod object
Attributes
- idstring
Unique identifier for the object.
- billing_
detailsobject Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- customernullable stringExpandable
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
- metadatanullable object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- typeenum
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
More attributes
- objectstring
- acss_
debitnullable object - affirmnullable object
- afterpay_
clearpaynullable object - alipaynullable object
- allow_
redisplaynullable enumPreview feature - amazon_
paynullable object - au_
becs_ debitnullable object - bacs_
debitnullable object - bancontactnullable object
- bliknullable object
- boletonullable object
- cardnullable object
- card_
presentnullable object - cashappnullable object
- createdtimestamp
- customer_
balancenullable object - epsnullable object
- fpxnullable object
- giropaynullable object
- grabpaynullable object
- idealnullable object
- interac_
presentnullable objectPreview feature - klarnanullable object
- konbininullable object
- linknullable object
- livemodeboolean
- mobilepaynullable objectPreview feature
- oxxonullable object
- p24nullable object
- paynownullable object
- paypalnullable object
- pixnullable object
- promptpaynullable object
- radar_
optionsnullable object - revolut_
paynullable object - sepa_
debitnullable object - sofortnullable object
- swishnullable object
- us_
bank_ accountnullable object - wechat_
paynullable object - zipnullable object
Create a PaymentMethod
Creates a PaymentMethod object. Read the Stripe.js reference to learn how to create PaymentMethods via Stripe.js.
Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment.
Parameters
- typeenumRequired
The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
- billing_
detailsobject Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- acss_
debitobject - affirmobject
- afterpay_
clearpayobject - alipayobject
- allow_
redisplayenum - amazon_
payobject - au_
becs_ debitobject - bacs_
debitobject - bancontactobject
- blikobject
- boletoobject
- cardobject
- cashappobject
- customer_
balanceobject - epsobject
- fpxobject
- giropayobject
- grabpayobject
- idealobject
- interac_
presentobjectPreview feature - klarnaobject
- konbiniobject
- linkobject
- mobilepayobjectPreview feature
- oxxoobject
- p24object
- paynowobject
- paypalobject
- pixobject
- promptpayobject
- radar_
optionsobject - revolut_
payobject - sepa_
debitobject - sofortobject
- swishobject
- us_
bank_ accountobject - wechat_
payobject - zipobject
Returns
Returns a PaymentMethod object.
Update a PaymentMethod
Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
Parameters
- billing_
detailsobject Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata
.
More parameters
- allow_
redisplayenum - cardobject
- linkobject
- us_
bank_ accountobject
Returns
Returns a PaymentMethod object.
Retrieve a Customer's PaymentMethod
Retrieves a PaymentMethod object for a given Customer.
Parameters
No parameters.
Returns
Returns a PaymentMethod object.