v8
OpenAPI 3.1.02026-08-033623795.0 MBSetup intents
List setup intents
Returns a paginated list of setup intents for a company, with optional filtering by creation date. A setup intent securely collects and stores a member's payment method for future use without charging them immediately.
Required permissions:
- payment:setup_intent:read
- member:basic:read
- member:email:read
get/setup_intents
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
company_idstring required
The unique identifier of the company to list setup intents for.
Example:biz_xxxxxxxxxxxxxx
direction'asc' | 'desc'
The direction of the sort.
created_beforestring date-time nullable
Only return setup intents created before this timestamp.
Example:2023-12-01T05:00:00.401Z
created_afterstring date-time nullable
Only return setup intents created after this timestamp.
Example:2023-12-01T05:00:00.401Z
Response
A successful response
Example response
{
"data": [
{
"checkout_configuration": {
"id": "ch_xxxxxxxxxxxxxxx"
},
"company": {
"id": "biz_xxxxxxxxxxxxxx"
},
"created_at": "2023-12-01T05:00:00.401Z",
"error_message": "Your card was declined.",
"id": "sint_xxxxxxxxxxxxx",
"payment_method": {
"card": {
"exp_month": 42,
"exp_year": 42,
"last4": "4242"
},
"created_at": "2023-12-01T05:00:00.401Z",
"id": "payt_xxxxxxxxxxxxx"
}
}
]
}