Returns a list of SetupAttempts that associate with a provided SetupIntent.
Parameters
- setup_
intentstringRequired Only return SetupAttempts created by the SetupIntent specified by this ID.
More parameters
- createdobject
A filter on the list, based on the object
created
field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.- created.
gtinteger Minimum value to filter by (exclusive)
- created.
gteinteger Minimum value to filter by (inclusive)
- created.
ltinteger Maximum value to filter by (exclusive)
- created.
lteinteger Maximum value to filter by (inclusive)
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
SetupAttempts that are created by the specified SetupIntent, which start after SetupAttempts starting_
. Each entry in the array is a separate SetupAttempts object. If no other SetupAttempts are available, the resulting array is be empty. This request should never raise an error.
{ "object": "list", "url": "/v1/setup_attempts", "has_more": false, "data": [ { "id": "setatt_1ErTsH2eZvKYlo2CI7ukcoF7", "object": "setup_attempt", "application": null, "created": 1562004309, "customer": null, "flow_directions": null, "livemode": false, "on_behalf_of": null, "payment_method": "pm_1ErTsG2eZvKYlo2CH0DNen59", "payment_method_details": { "card": { "three_d_secure": null }, "type": "card" }, "setup_error": null, "setup_intent": "seti_1ErTsG2eZvKYlo2CKaT8MITz", "status": "succeeded", "usage": "off_session" } ]}