Profile, Billing and Access Control API Overview

There are four main categories are:

auth

This category contains APIs related to authenticating users such as registration, login, updating a user password, etc.

billing

This category contains APIs to manage the checkout, billing and accounting workflows, including shopping carts, coupons, charges and balance statements.

profile

This category contains APIs to manage profiles, including contact information, password updates, subscriptions, and roles.

metrics

This category contains APIs to crunch numbers and create reporting dashboards.

Query parameters and results returned

There are three main formats for results returned:

• a single item
• a list of items
• a table of aggregated values over a metric

When you call an API URL that returns a single item, the result will include all the details of that item. When you call an API URL that returns a list of items, each item returned will contain a short version with fields typically necessary to display in a Human User Interface (ex: printable_name ).

List APIs accept query parameters start_at and ends_at, which are dates in ISO format to filter items returned by their creation date. The q parameter is used to do random searches while the q_f parameter is used to further restrict which fields are searched for a matching q term.

The items returned can be sorted by a field specified in the o query parameter, while a minus sign preceding the field name will sort by reverse order.

List results are paginated, thus the page query parameter specifies the page of results to return. By default the query returns the first page.

Fields encoding