A setup intent is an object used to securely collect and store a member’s payment method for future use without charging them immediately. It handles authentication steps up front so future off-session payments can be completed smoothly. This ensures the payment method is verified and ready for later billing.
Required permissions:
payment:setup_intent:readmember:basic:readmember:email:readThe app API key from an app from the /dashboard/developer page
The ID of the Setup Intent
"sint_xxxxxxxxxxxxx"
A successful response
An object representing a setup intent, which is a flow for allowing a customer to add a payment method to their account without making a purchase.
The setup intent ID
"sint_xxxxxxxxxxxxx"
The status of the setup intent
processing, succeeded, canceled, requires_action The datetime the payment was created
"2023-12-01T05:00:00.401Z"
The error message, if any.
The company of the setup intent
The checkout configuration associated with the setup intent
The member connected to the setup intent
The payment method created during the setup, if available.
The metadata associated with the setup intent