Component: Price Points

List All Components Price Points

GET
/components_price_points.json

Lists all component price points belonging to a site.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Query Parameters

include?"currency_prices"

Allows including additional data in the response. Use in query: include=currency_prices.

Value in

  • "currency_prices"
page?integer

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1.

Range1 <= value
Default1
per_page?integer

This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query per_page=200.

Rangevalue <= 200
Default20
direction?Sorting direction

Controls the order in which results are returned. Use in query direction=asc.

Value in

  • "asc"
  • "desc"
filter?

Filter to use for List PricePoints operations

Response Body

application/json

application/json

curl -X GET "https://example.com/components_price_points.json"
{  "price_points": [    {      "id": 1,      "name": "Auto-created",      "type": "default",      "pricing_scheme": "per_unit",      "component_id": 2,      "handle": "auto-created",      "archived_at": null,      "created_at": "2021-02-21T11:05:57-05:00",      "updated_at": "2021-02-21T11:05:57-05:00",      "prices": [        {          "id": 3,          "component_id": 2,          "starting_quantity": 0,          "ending_quantity": null,          "unit_price": "1.0",          "price_point_id": 1,          "formatted_unit_price": "$1.00",          "segment_id": null        }      ],      "tax_included": false    }  ]}