Sign in

Update a PaymentMethod

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

post/v1/payment_methods/{payment_method}

Path parameters

payment_methodstring required

Response

Successful response.

affirmPaymentMethodAffirm
afterpay_clearpayPaymentMethodAfterpayClearpay
alipayPaymentFlowsPrivatePaymentMethodsAlipay
allow_redisplay'always' | 'limited' | 'unspecified'

This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”.

almaPaymentMethodAlma
amazon_payPaymentMethodAmazonPay
bancontactPaymentMethodBancontact
blikPaymentMethodBlik
createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

customer_balancePaymentMethodCustomerBalance
giropayPaymentMethodGiropay
grabpayPaymentMethodGrabpay
idstring required

Unique identifier for the object.

kakao_payPaymentMethodKakaoPay
konbiniPaymentMethodKonbini
livemodeboolean required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadataobject nullable

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.

mobilepayPaymentMethodMobilepay
multibancoPaymentMethodMultibanco
object'payment_method' required

String representing the object's type. Objects of the same type share the same value.

oxxoPaymentMethodOxxo
pay_by_bankPaymentMethodPayByBank
paycoPaymentMethodPayco
paynowPaymentMethodPaynow
pixPaymentMethodPix
promptpayPaymentMethodPromptpay
revolut_payPaymentMethodRevolutPay
samsung_payPaymentMethodSamsungPay
swishPaymentMethodSwish
twintPaymentMethodTwint
type'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'card_present' | 'cashapp' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'interac_present' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'us_bank_account' | 'wechat_pay' | 'zip' required

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.

wechat_payPaymentMethodWechatPay
zipPaymentMethodZip

Changes