GET /v1/prices

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Query parameters

Name Type Required Description
created No

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.

limit Integer No

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

active Boolean No

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

starting_after String No

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.

expand[] Array No

Specifies which fields in the response should be expanded.

product String No

Only return prices for the given product.

recurring Object No

Only return prices with these recurring fields.

type String No

Only return prices of type recurring or one_time.

Possible values:

  • "recurring"
  • "one_time"
ending_before String No

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.

lookup_keys[] Array No

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

currency String No

Only return prices for the given currency.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.