SetupIntent

A setup intent guides you through the process of setting up and saving a customer's payment credentials for future payments.

Properties

• id (string): Unique identifier for the setup intent.
• object (string): String representing the object's type (always "setup_intent").
• application (string): ID of the Connect application that created the setup intent.
• attachToSelf (boolean): Whether to attach the payment method to the platform account.
• canceledAt (number): Time at which the setup intent was canceled (Unix timestamp).
• cancellationReason (string): Reason for cancellation (abandoned, duplicate, requested_by_customer).
• clientSecret (string): The client secret used for client-side retrieval.
• confirmationMethod (string): How the setup intent will be confirmed (automatic, manual).
• created (number): Time at which the object was created (Unix timestamp).
• customer ([[Customer]]): ID of the customer this setup intent belongs to.
• description (string): An arbitrary string attached to the object.
• lastSetupError (object): The error encountered in the previous setup attempt.
• latestAttempt (string): ID of the most recent SetupAttempt.
• livemode (boolean): Whether in live mode or test mode.
• mandateData (object): Data used to generate mandate acceptance.
• metadata (object): Set of key-value pairs for storing additional information.
• nextAction (object): Next action for the setup intent to take.
• onBehalfOf (string): Connected account the setup intent was created on behalf of.
• paymentMethod ([[PaymentMethod]]): ID of the payment method used with this setup intent.
• paymentMethodOptions (object): Payment method-specific options.
• paymentMethodTypes (string[]): Payment method types that can be used with this intent.
• singleUseMandate (string): ID of the single-use mandate generated.
• status (string): Status of the setup intent (requires_payment_method, requires_confirmation, requires_action, processing, canceled, succeeded).
• usage (string): How the payment method is intended to be used (off_session, on_session).

Actions

create

Create a new setup intent.

Input: [[SetupIntent]]
Output: [[SetupIntent]]

retrieve

Retrieve the details of a setup intent.

Input: [[SetupIntent]]
Output: [[SetupIntent]]

update

Update properties of a setup intent.

Input: [[SetupIntent]]
Output: [[SetupIntent]]

confirm

Confirm that the customer intends to set up payment.

Input: [[SetupIntent]]
Output: [[SetupIntent]]

cancel

Cancel a setup intent.

Input: [[SetupIntent]]
Output: [[SetupIntent]]

list

Return a list of setup intents.

Input: [[ListRequest]]
Output: [[SetupIntentList]]

Events

• created: Triggered when a setup intent is created.
• canceled: Triggered when a setup intent is canceled.
• requiresAction: Triggered when a setup intent requires customer action.
• setupFailed: Triggered when a setup attempt fails.
• succeeded: Triggered when a setup intent succeeds.