Skip to main content

A setup intent allows a user to save a payment method for future use without making an immediate purchase.

id
string
required

The unique identifier for the setup intent.

Example:

"sint_xxxxxxxxxxxxx"

status
enum<string>
required

The current status of the setup intent.

Available options:
processing,
succeeded,
canceled,
requires_action
created_at
string<date-time>
required

The datetime the setup intent was created.

Example:

"2023-12-01T05:00:00.401Z"

error_message
string | null
required

A human-readable error message explaining why the setup intent failed. Null if no error occurred.

Example:

"Your card was declined."

company
object
required

The company that initiated this setup intent. Null if the company has been deleted.

checkout_configuration
object
required

The checkout session configuration associated with this setup intent. Null if no checkout session was used.

member
object
required

The company member associated with this setup intent. Null if the user is not a member.

payment_method
object
required

The saved payment method created by this setup intent. Null if the setup has not completed successfully.

metadata
object
required

Custom key-value pairs attached to this setup intent. Null if no metadata was provided.