StripeKit - Create Setup Intent

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

Creates a Stripe SetupIntent, the entry point for saving a customer's card for later use, without charging them anything right now. Confirmed on the frontend with Stripe Elements.

Signature

Parameters

Field	Type	Required	Description
`customerId`	`string`	Yes	The customer this saved payment method will belong to.
`usage`	`string`	No, defaults to `'off_session'`	Either `'off_session'` (the customer is not present for future charges) or `'on_session'`.
`metadata`	`array<string,string>`	No	Arbitrary metadata stored on the `SetupIntent`.

Example request

Example response

Errors

Exception	When
`StripeOperationError`	The customer ID does not exist.

Using the result

Pass clientSecret to your frontend and confirm it with the bundled Stripe Elements helper:

See Stripe Elements for the full frontend flow.

Notes

This call does not itself save anything to your storage adapter. Once the customer confirms the SetupIntent on the frontend, call list() or sync() to pull the newly saved payment method into your own database. StripeKit's webhook handling also does this automatically for the setup_intent.succeeded event, see Webhooks.

Create Setup Intent

$kit->paymentMethods->createSetupIntent()#

Signature#

Parameters#

Example request#

Example response#

Errors#

Using the result#

Notes#