StripeKit - Attach Payment Method

`$kit->paymentMethods->attach()`

Attaches a payment method that already exists in Stripe (typically created client-side by Stripe Elements or Stripe.js) to a customer, optionally making it the default.

Signature

Parameters

Field	Type	Required	Description
`paymentMethodId`	`string`	Yes	The Stripe payment method ID to attach, for example `pm_...`.
`customerId`	`string`	Yes	The customer to attach it to.
`setAsDefault`	`bool`	No, defaults to `false`	If `true`, also sets this payment method as the customer's default via `invoice_settings.default_payment_method`.

Example request

Example response

Errors

Exception	When
`StripeOperationError`	The payment method is already attached to a different customer, the ID does not exist, or Stripe otherwise rejects the request.

Notes

This method does not create a payment method, it only attaches one that already exists. Payment methods are normally created on the frontend with Stripe.js or Stripe Elements, never with your secret key. See Stripe Elements.

isDefault in the response only reflects setAsDefault from this call, not the customer's actual current default in Stripe. Call list() if you need the true default status alongside every other saved method.

Attach

$kit->paymentMethods->attach()#

Signature#

Parameters#

Example request#

Example response#

Errors#