List all prices

GET {{baseUrl}}/v1/prices

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

Request Params

KeyDatatypeRequiredDescription
activestringOnly return prices that are active or inactive (e.g., pass false to list all inactive prices).
created[gt]stringA filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
created[gte]stringA filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
created[lt]stringA filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
created[lte]stringA filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
currencystringOnly return prices for the given currency.
ending_beforestringA 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.
expand[0]stringSpecifies which fields in the response should be expanded.
expand[1]stringSpecifies which fields in the response should be expanded.
limitstringA limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
lookup_keys[0]stringOnly return the price with these lookup_keys, if any exist.
lookup_keys[1]stringOnly return the price with these lookup_keys, if any exist.
productstringOnly return prices for the given product.
recurring[interval]stringOnly return prices with these recurring fields.
recurring[meter]stringOnly return prices with these recurring fields.
recurring[usage_type]stringOnly return prices with these recurring fields.
starting_afterstringA 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.
typestringOnly return prices of type recurring or one_time.

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring