Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListLocationsParameters

Parameters to be used when calling listLocations() to list the Location objects associated with an account.

see

https://stripe.com/docs/terminal/readers/connecting

Hierarchy

  • ListLocationsParameters

Index

Properties

endingBefore?: string

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.

see

https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-ending_before

limit?: number

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

default

10

see

https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-limit

startingAfter?: string

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.

see

https://stripe.com/docs/api/terminal/locations/list#list_terminal_locations-starting_after

Generated using TypeDoc