List Products for Product Family
Retrieves a list of Products belonging to a Product Family.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
Either the product family's id or its handle 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 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 <= 20020The 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 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 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 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-timeThe 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-timeInclude archived products.
Allows including additional data in the response. Use in query include=prepaid_product_price_point.
Value in
- "prepaid_product_price_point"
Response Body
application/json
application/json
curl -X GET "https://example.com/product_families/string/products.json"[ { "product": { "id": 3801242, "name": "Free product", "handle": "zero-dollar-product", "description": "", "accounting_code": "", "request_credit_card": true, "expiration_interval": null, "expiration_interval_unit": "never", "created_at": "2016-04-21T16:08:39-04:00", "updated_at": "2016-08-03T11:27:53-04:00", "price_in_cents": 10000, "interval": 1, "interval_unit": "month", "initial_charge_in_cents": 0, "trial_price_in_cents": null, "trial_interval": null, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": false, "return_params": "", "taxable": false, "update_return_url": "", "initial_charge_after_trial": false, "version_number": 4, "update_return_params": "", "product_family": { "id": 527890, "name": "Acme Projects", "description": "", "handle": "billing-plans", "accounting_code": null }, "public_signup_pages": [ { "id": 283460, "return_url": null, "return_params": "", "url": "https://general-goods.chargify.com/subscribe/smcc4j3d2w6h/zero-dollar-product" } ], "product_price_point_name": "Default", "use_site_exchange_rate": true } }, { "product": { "id": 3858146, "name": "Calendar Billing Product", "handle": "calendar-billing-product", "description": "", "accounting_code": "", "request_credit_card": true, "expiration_interval": null, "expiration_interval_unit": "never", "created_at": "2016-07-05T13:07:38-04:00", "updated_at": "2016-07-05T13:07:38-04:00", "price_in_cents": 10000, "interval": 1, "interval_unit": "month", "initial_charge_in_cents": null, "trial_price_in_cents": null, "trial_interval": null, "trial_interval_unit": "month", "archived_at": null, "require_credit_card": true, "return_params": "", "taxable": false, "update_return_url": "", "initial_charge_after_trial": false, "version_number": 1, "update_return_params": "", "product_family": { "id": 527890, "name": "Acme Projects", "description": "", "handle": "billing-plans", "accounting_code": null }, "public_signup_pages": [ { "id": 289193, "return_url": "", "return_params": "", "url": "https://general-goods.chargify.com/subscribe/gxdbfxzxhcjq/calendar-billing-product" } ], "product_price_point_name": "Default", "use_site_exchange_rate": true } }]