List Product Price Points
Retrieves a list of product price points.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The id or handle of the product. When using the handle, it must be prefixed with handle:
Query Parameters
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 10. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
value <= 20010(Optional) If you have defined multiple currencies at the site level, you can pass ?currency_prices=true to include an array of currency price data in the response. If the product 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.
Use in query: filter[type]=catalog,default.
Set to include archived price points in the response.
Response Body
application/json
curl -X GET "https://example.com/products/0/price_points.json"{ "price_points": [ { "id": 283, "name": "Educational", "handle": "educational", "price_in_cents": 1000, "interval": 1, "interval_unit": "month", "trial_price_in_cents": 4900, "trial_interval": 1, "trial_interval_unit": "month", "trial_type": "payment_expected", "initial_charge_in_cents": 120000, "initial_charge_after_trial": false, "expiration_interval": 12, "expiration_interval_unit": "month", "product_id": 901, "archived_at": "2023-11-30T06:37:20-05:00", "created_at": "2023-11-27T06:37:20-05:00", "updated_at": "2023-11-27T06:37:20-05:00" } ]}