List all SetupAttempts 

Core Resources
Setup Attempts
List all SetupAttempts

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_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

  • 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_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

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

GET /v1/setup_attempts
curl -G https://api.stripe.com/v1/setup_attempts \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d limit=3 \
-d setup_intent=seti_1ErTsG2eZvKYlo2CKaT8MITz
Response
{
"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"
}
]
}