Sample - Stripe API
GET/v1/topups

List all top-ups

Lists top-ups recorded for the account balance. Use status, created, and amount to filter results, and use cursor parameters with limit to paginate the list.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 parameters
amountobjectoptional
Filter by a positive integer amount or an amount range.
createdobjectoptional
Filter top-ups by creation time using a Unix timestamp or a range with `gt`, `gte`, `lt`, or `lte`.
ending_beforestringoptional
Cursor identifying the first object to exclude when retrieving the previous page.
expandarray<string>optional
Fields to expand in each returned object. Each value must be a string no longer than 5000 characters.
limitintegeroptional
Maximum number of top-ups to return. Must range from 1 to 100. Defaults to 10 when omitted.
starting_afterstringoptional
Cursor identifying the last object to exclude when retrieving the next page.
statusstringoptional
Filter by top-up status: canceled, failed, pending, or succeeded.
Allowed:canceledfailedpendingsucceeded

2 status codes
200Returns a paginated list containing top-up objects, a `has_more` indicator, the list object type, and the list URL.
dataarray<TopUp>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

status must be one of canceled, failed, pending, or succeeded. limit must be between 1 and 100, and amount must be a positive integer when supplied.