Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the setup intent.

Example:

"sint_xxxxxxxxxxxxx"

Response

A successful response

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

checkout_configuration
object | null
required

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

company
object | null
required

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

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."

id
string
required

The unique identifier for the setup intent.

Example:

"sint_xxxxxxxxxxxxx"

member
object | null
required

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

metadata
object | null
required

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

payment_method
object | null
required

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

status
enum<string>
required

The current status of the setup intent.

Available options:
processing,
succeeded,
canceled,
requires_action
three_ds_verified
boolean
required

Whether 3D Secure authentication was completed when this payment method was set up.