List Component Price Points
Lists the price points associated with a component.
You may specify the component by using either the numeric id or the handle:gold syntax.
If the price point is set to use_site_exchange_rate: true, it will return pricing based on the current exchange rate. If the flag is set to false, it will return all of the defined prices for each currency.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Advanced Billing id of the component
Query Parameters
Include an array of currency price data.
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.
1 <= value1This 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.
value <= 20020Use in query: filter[type]=catalog,default.
Response Body
application/json
curl -X GET "https://example.com/components/0/price_points.json"{ "price_points": [ { "id": 80, "default": false, "name": "Wholesale Two", "pricing_scheme": "per_unit", "component_id": 74, "handle": "wholesale-two", "archived_at": null, "created_at": "2017-07-05T13:55:40-04:00", "updated_at": "2017-07-05T13:55:40-04:00", "prices": [ { "id": 121, "component_id": 74, "starting_quantity": 1, "ending_quantity": null, "unit_price": "5.0" } ] }, { "id": 81, "default": false, "name": "MSRP", "pricing_scheme": "per_unit", "component_id": 74, "handle": "msrp", "archived_at": null, "created_at": "2017-07-05T13:55:40-04:00", "updated_at": "2017-07-05T13:55:40-04:00", "prices": [ { "id": 122, "component_id": 74, "starting_quantity": 1, "ending_quantity": null, "unit_price": "4.0" } ] } ]}Promote Price Point to Default PUT
Sets a new default price point for the component. This new default will apply to all new subscriptions going forward - existing subscriptions will remain on their current price point. See [Price Points Documentation](https://maxio.zendesk.com/hc/en-us/articles/24261191737101-Price-Points-Components) for more information on price points and moving subscriptions between price points. Note: Custom price points are not able to be set as the default for a component.
Create Component Price Point POST
Creates a price point for an existing component.