Product: Price Points

List All Products Price Points

GET
/products_price_points.json

Lists Product 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

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

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

Response Body

application/json

application/json

curl -X GET "https://example.com/products_price_points.json"
{  "price_points": [    {      "id": 0,      "name": "My pricepoint",      "handle": "handle",      "price_in_cents": 10,      "interval": 5,      "interval_unit": "month",      "trial_price_in_cents": 10,      "trial_interval": 1,      "trial_interval_unit": "month",      "trial_type": "payment_expected",      "introductory_offer": true,      "initial_charge_in_cents": 0,      "initial_charge_after_trial": true,      "expiration_interval": 0,      "expiration_interval_unit": "month",      "product_id": 1230,      "created_at": "2021-04-02T17:52:09-04:00",      "updated_at": "2021-04-02T17:52:09-04:00",      "use_site_exchange_rate": true    }  ]}