Maxio Advanced Billing
HomeSDKsAPI ReferenceContext Plugin
Product Families

List Product Families

GET
/product_families.json

Lists Product Families for a site.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Query Parameters

date_field?Basic Date Field

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"
start_date?string

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.

Formatdate
end_date?string

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.

Formatdate
start_datetime?string

The 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.

Formatdate-time
end_datetime?string

The 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.

Formatdate-time

Response Body

application/json

curl -X GET "https://example.com/product_families.json"
[  {    "product_family": {      "id": 37,      "name": "Acme Projects",      "description": null,      "handle": "acme-projects",      "accounting_code": null,      "surcharging": false,      "created_at": "2013-02-20T15:05:51-07:00",      "updated_at": "2013-02-20T15:05:51-07:00",      "archived_at": null    }  },  {    "product_family": {      "id": 155,      "name": "Bat Family",      "description": "Another family.",      "handle": "bat-family",      "accounting_code": null,      "surcharging": true,      "created_at": "2014-04-16T12:41:13-06:00",      "updated_at": "2014-04-16T12:41:13-06:00",      "archived_at": "2024-11-05T09:30:00-07:00"    }  }]

List Products for Product Family GET

Retrieves a list of Products belonging to a Product Family.

Create Product Family POST

Creates a Product Family within your site. Create a Product Family to act as a container for your products, components, and coupons. Full documentation on how Product Families operate within the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261098936205-Product-Families).