StripeKit - Sync Customer

`kit.customers.sync()`

Re-fetches a customer from Stripe and persists the fresh record via your storage adapter's saveCustomer(). Functionally identical to retrieve(), except the result is always written to storage, even if you don't do anything else with the return value.

Signature

Example request

Example response

Same shape as retrieve().

When to use this

After a support agent manually edits a customer in the Stripe Dashboard, to pull that change back into your own database.

As part of a scheduled reconciliation job.

Inside a webhook handler, to make sure your database reflects the very latest state rather than only the fields present on the webhook event payload. See kit.sync.everythingForCustomer() for pulling a customer plus all of their related objects in one call.

Notes

Without a storage adapter configured, sync() still works and still returns the fresh record, it just has nothing to persist to.

Sync

kit.customers.sync()#

Signature#

Example request#

Example response#