List Components for Product Family
Lists components for a particular product family.
Authorization
BasicAuth The username is a Maxio Chargify API key. The password is x.
In: header
Path Parameters
The Advanced Billing id of the product family
Query Parameters
Include archived items.
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 <= 20020Filter to use for List Components operations
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"
The end date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp up to and including 11:59:59PM in your site’s time zone on the date specified.
The end date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components 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.
The start date (format YYYY-MM-DD) with which to filter the date_field. Returns components with a timestamp at or after midnight (12:00:00 AM) in your site’s time zone on the date specified.
The start date and time (format YYYY-MM-DD HH:MM:SS) with which to filter the date_field. Returns components 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.
Response Body
application/json
curl -X GET "https://example.com/product_families/0/components.json"[ { "component": { "id": 399850, "name": "$1.00 component", "pricing_scheme": "per_unit", "unit_name": "Component", "unit_price": "1.0", "product_family_id": 997233, "price_per_unit_in_cents": null, "kind": "quantity_based_component", "archived": false, "taxable": false, "description": "Component", "default_price_point_id": 121000, "prices": [ { "id": 630687, "component_id": 399850, "starting_quantity": 1, "ending_quantity": null, "unit_price": "1.0", "price_point_id": 121000, "formatted_unit_price": "$1.00" } ], "price_point_count": 2, "price_points_url": "https://general-goods.chargify.com/components/399850/price_points", "tax_code": null, "recurring": true, "upgrade_charge": null, "downgrade_credit": null, "created_at": "2019-08-01T09:35:38-04:00", "default_price_point_name": "Original", "product_family_name": "Chargify", "use_site_exchange_rate": true } }, { "component": { "id": 399853, "name": "Annual Support Services", "pricing_scheme": null, "unit_name": "on/off", "unit_price": "100.0", "product_family_id": 997233, "price_per_unit_in_cents": null, "kind": "on_off_component", "archived": false, "taxable": true, "description": "Prepay for support services", "default_price_point_id": 121003, "price_point_count": 4, "price_points_url": "https://general-goods.chargify.com/components/399853/price_points", "tax_code": "D0000000", "recurring": true, "upgrade_charge": null, "downgrade_credit": null, "created_at": "2019-08-01T09:35:37-04:00", "default_price_point_name": "Original", "product_family_name": "Chargify", "use_site_exchange_rate": true } }, { "component": { "id": 386937, "name": "Cancellation fee", "pricing_scheme": null, "unit_name": "on/off", "unit_price": "35.0", "product_family_id": 997233, "price_per_unit_in_cents": null, "kind": "on_off_component", "archived": false, "taxable": false, "description": "", "default_price_point_id": 108307, "price_point_count": 1, "price_points_url": "https://general-goods.chargify.com/components/386937/price_points", "tax_code": null, "recurring": true, "upgrade_charge": null, "downgrade_credit": null, "created_at": "2019-08-01T09:35:38-04:00", "default_price_point_name": "Original", "product_family_name": "Chargify", "use_site_exchange_rate": true } }]Update Component PUT
Updates a component. You may read the component by either the component's id or handle. When using the handle, it must be prefixed with `handle:`. If you have the new [Catalog experience](https://maxio-test-wp.pages.dev/support/announcements/2026-announcements#new-catalog-experience-and-terminology) enabled, taxable components must include a non-blank `tax_code`. Sending `"tax_code": ""` returns `422`.
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.