StripeKit - Checkout Submit Fields

`kit.checkout.submitFields()`

Validates and stores custom field values for a checkout session created with customFields, and best-effort mirrors them onto the underlying Stripe PaymentIntent or Subscription's metadata.

Signature

Parameters

Field	Type	Description
`checkoutId`	`string`	The session returned by `create()`.
`submitted`	`Record<string,string>`	Keyed by each field's `key`, as defined in `customFields`.

Example request

Example response

Only the validated values that passed, keyed the same way as submitted:

Errors

Exception	When
`NotFoundError`	The checkout session was not found.
`ValidationError`	The session is no longer `'open'` (already completed); or one or more fields fail validation, in which case `error.fieldErrors` is an array keyed by field `key` with a human-readable message per field, for example `{ company_name: 'Company name is required.' }`.

Notes

Required fields left blank, and fields that don't match their configured pattern, are collected into a single ValidationError, so you can show every problem to the customer at once instead of one at a time.

After validation succeeds, StripeKit best-effort writes each value onto the underlying Stripe object's metadata as field_<key>, wrapped in its own try/catch so a metadata write failure never blocks the checkout itself.

Submit Fields

kit.checkout.submitFields()#

Signature#

Parameters#

Example request#

Example response#

Errors#