Attach a PaymentMethod to a Customer

Attaches a PaymentMethod object to a Customer.
To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments.

To use this PaymentMethod as the default for invoice or subscription payments, set invoice_settings.default_payment_method, on the Customer to the PaymentMethod’s ID.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Path Params

paymentmethod_id

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

customer

string

required

The ID of the customer to which to attach the PaymentMethod.

Example

{
  "customer": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object, like 'pm_xxxxx'

object

string

optional

'payment method'

created

integer

optional

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

customer

string

optional

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.

metadata

object

optional

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.

livemode

boolean

optional

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

billing_details

object (Billing Details)

optional

Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

address

object (Address)

optional

string

optional

Email address.

name

string

optional

Full name.

phone

string

optional

Billing phone number (including extension).

type

enum<string>

required

The type of the PaymentMethod. An additional object is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

Allowed values:

cardalipayplusalipaywechat_paysepa_debitalipay_hkboosttruemoneygcashkakaopaytouchngorabbit_line_paydanaklarnaidealgiropaysofortepstrustlybancontactp24unionpayfpxmcashgrabpaybank_transfer_idqrispromptpayovoshopeepayupiboletopaynowpix9paystitchbpi

card

object

optional

If this is a card PaymentMethod, this object contains the user’s card details.

brand

string

optional

American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown

checks

object

optional

country

string

optional

Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected.

exp_month

integer

optional

Two-digit number representing the card’s expiration month.

exp_year

integer

optional

Four-digit number representing the card’s expiration year.

fingerprint

string

optional

Uniquely identifies this particular card number.

funding

string

optional

Can be credit, debit, prepaid, or unknown.

last4

string

optional

The last four digits of the card.

metadata

object

optional

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.

Example

{
  "id": "string",
  "object": "string",
  "created": 0,
  "customer": "string",
  "metadata": {},
  "livemode": true,
  "billing_details": {
    "address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "email": "string",
    "name": "string",
    "phone": "string"
  },
  "type": "card",
  "card": {
    "brand": "string",
    "checks": {
      "address_line1_check": "string",
      "address_zip_check": "string",
      "cvc_check": "string"
    },
    "country": "string",
    "exp_month": 0,
    "exp_year": 0,
    "fingerprint": "string",
    "funding": "string",
    "last4": "string",
    "metadata": {}
  }
}