younifyd
Menu

List Price Segments

List a site's price segments

GET/price_segments

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Price Segments action (under price_segment).
  3. Fill in the fields below, then reference the result from later steps as {{listPriceSegments.response.data}}.

Request

Query parameters

idsarray<string>

Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.

limitinteger

Limit number of records 1-200.

Default 20

orderstring

Sort order.

One ofascdescDefault "desc"

Response

Returns 200 with an object. Read it in later steps with {{listPriceSegments.response.data.<field>}}.

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>
objectstring
idstring

The price segment ID, e.g. `e28zov4fw0v2`.

codestring

The price segment code, e.g. `my-price-segment`.

json
{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "object": "string",
      "id": "string",
      "code": "string"
    }
  ]
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.

List Price Segments — Recurly — Documentation