List all prices

Changed on

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

get/v1/prices

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/prices
  • Auth: HTTP bearer

Query parameters

activeboolean

Only return prices that are active or inactive (e.g., pass false to list all inactive prices).

OR
integer

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

currencystring currency

Only return prices for the given currency.

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.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

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

lookup_keysstring[]

Only return the price with these lookup_keys, if any exist. You can specify up to 10 lookup_keys.

productstring

Only return prices for the given product.

interval'day' | 'month' | 'week' | 'year'
meterstring
usage_type'licensed' | 'metered'

Only return prices with these recurring fields.

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.

type'one_time' | 'recurring'

Only return prices of type recurring or one_time.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes