Skip to main content
Vindicia Knowledge Center

List events

List events

Fetch a list of all events on an Account, Subscription, Product, or Rate Plan.

Route (URL) Parameters

None.

Query Parameters

Parameter Default Description Required
limit 20 A limit on the number of objects to be returned, between 1 and 100. No
starting_after none 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. No
ending_before none 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. No

Accepts

None.

Returns

JSON A list array with a data property that contains an array of up to limit Events, starting after the specified starting_after Event (or ending before the specified ending_before Event). Each entry in the array is a full Event object. If no more objects are available, the resulting array will be empty. This request should never throw an error.

A list of objects matching the query. Also:

  • “total_count”: Integer count of the number of objects in the returned list.
  • “url”: The query string provided in the request
  • “next”: The route (partial URL) to the next Event object (string to select the “next”); included id should match that of the last object returned here
  • “previous”: The route (partial URL) to the previous Event object (string to select the “previous”); included id should match that of the first object returned here
  • cURL
  • Java
 
 

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top