List Products
Lists products belonging to a site.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Query Parameters
The type of filter you would like to apply to your search.
Use in query: date_field=created_at.
Value in
- "updated_at"
- "created_at"
Filter to use for List Products operations
The end date (format YYYY-MM-DD) with which to filter the date_field. Returns products with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
dateThe end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns products with a timestamp at or before exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of end_date.
date-timeThe start date (format YYYY-MM-DD) with which to filter the date_field. Returns products with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
dateThe start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns products with a timestamp at or after exact time provided in query. You can specify timezone in query - otherwise your site''s time zone will be used. If provided, this parameter will be used instead of start_date.
date-timeResult 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 <= 20020Include archived products. Use in query: include_archived=true.
Allows including additional data in the response. Use in query include=prepaid_product_price_point.
Value in
- "prepaid_product_price_point"
When true, embeds the active feature catalog items for each result in a features array. Default value is false.
falseResponse Body
application/json
curl -X GET "https://example.com/products.json"[ { "product": { "id": 0, "name": "string", "handle": "string", "description": "string", "accounting_code": "string", "request_credit_card": true, "expiration_interval": 0, "expiration_interval_unit": "month", "created_at": "2023-11-23T10:28:34-05:00", "updated_at": "2023-11-23T10:28:34-05:00", "price_in_cents": 0, "interval": 0, "interval_unit": "month", "initial_charge_in_cents": 0, "trial_price_in_cents": 0, "trial_interval": 0, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": true, "return_params": "string", "taxable": true, "update_return_url": "string", "initial_charge_after_trial": true, "version_number": 0, "update_return_params": "string", "product_family": { "id": 0, "name": "string", "handle": "string", "accounting_code": null, "description": "string", "created_at": "2021-05-05T16:00:21-04:00", "updated_at": "2021-05-05T16:00:21-04:00" }, "public_signup_pages": [ { "id": 0, "return_url": "string", "return_params": "string", "url": "string" } ], "product_price_point_name": "string", "request_billing_address": true, "require_billing_address": true, "require_shipping_address": true, "use_site_exchange_rate": true, "tax_code": "string", "default_product_price_point_id": 0 } }]