Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Query Parameters
Filter by Addendum ID. Can be multiple.
Filter by calculation rule type. Can be multiple.
* commit
- commit
* overcommit
- overcommit
* stepped
- stepped
* staged
- staged
* unit
- unit
* post_invoice
- post_invoice
Filter by client ID. Can be multiple.
Filter by client's company name (client's name). Case insensitive. Supports partial matches.
Filter by creation date-time.
Returns items created after the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space, or just a date.
Examples:
* &
created_after=2025-05-15
* &
created_after=2025-05-15 12:00:00
* &
created_after=2025-05-15T12:00:00Z
Filter by creation date-time.
Returns items created before the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space, or just a date.
Examples:
* &
created_before=2025-05-15
* &
created_before=2025-05-15 12:00:00
* &
created_before=2025-05-15T12:00:00Z
Filter by currency char code (e.g. USD, EUR). Can be multiple.
Returns currencies with the specified char code.
Examples:
* &
currency_char_code=USD
* &
currency_char_codeEUR¤cy_char_codeUSD
Available values:
* EUR
- Euro
* USD
- US Dollar
Filter by currency ID. Can be multiple.
Returns currencies with the specified ID.
Examples:
* &
currency_id=1
* &
currency_id=1&
currency_id=2
Available values:
* 1
- US Dollar
* 2
- Euro
Filter by deleted status.
Returns items based on their deletion status.
* true
- only deleted items
* false
- only non-deleted items
* none
- all items (default)
Filter by Discount ID. Can be multiple.
Filter by feature ID. Can be multiple.
Filter by feature name. Case insensitive. Supports partial matches.
Filter by date.
Returns items for the specified date (ISO 8601 format, UTC.)
Examples:
* &
for_date=2025-05-15
Filter by date.
Returns items after and including the specified date (ISO 8601 format, UTC.)
Examples:
* &
for_date_after=2025-05-15
Filter by date.
Returns items on or before the specified date (ISO 8601 format, UTC.)
Examples:
* &
for_date_before=2025-05-15
Number of results to return per page. Maximum is 100
.
Filter by metric code. Case insensitive. Supports partial matches.
Filter by metric ID. Can be multiple.
The initial index from which to return the results.
Ordering of the results.
Default sort order is ascending. Put -
before value for descending sort order: -id
.
For sorting by multiple parameters write them as comma separated string: -
client_id,id
.
* addendum_id
- Addendum id
* -addendum_id
- Addendum id (descending)
* period_range_start
- Period range start
* -period_range_start
- Period range start (descending)
* period_range_end
- Period range end
* -period_range_end
- Period range end (descending)
* calc_rule_type
- Calc rule type
* -calc_rule_type
- Calc rule type (descending)
* created_at
- Created at
* -created_at
- Created at (descending)
* currency_id
- Currency id
* -currency_id
- Currency id (descending)
* feature_name
- Feature name
* -feature_name
- Feature name (descending)
* for_date
- For date
* -for_date
- For date (descending)
* id
- Id
* -id
- Id (descending)
* money_value
- Money value
* -money_value
- Money value (descending)
* plan_item_id
- Plan item id
* -plan_item_id
- Plan item id (descending)
* product_name
- Product name
* -product_name
- Product name (descending)
* product_id
- Product id
* -product_id
- Product id (descending)
* tax_rate
- Tax rate
* -tax_rate
- Tax rate (descending)
* region_id
- Region id
* -region_id
- Region id (descending)
* region_name
- Region name
* -region_name
- Region name (descending)
Filter by payer ID. Can be multiple.
Filter by period range.
Returns items with a period containing the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space.
Examples:
* ._contains=2025-05-15 12:00:00
* ._contains=2025-05-15T12:00:00Z
Filter by period range.
Returns items with a period ending before the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space.
Examples:
* ._ends_before=2025-05-15 12:00:00
* ._ends_before=2025-05-15T12:00:00Z
Filter by period range.
Returns items excluding those with a period containing the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space.
Examples:
* ._outside=2025-05-15 12:00:00
* ._outside=2025-05-15T12:00:00Z
Filter by period range.
Returns items with a period beginning after the specified date-time (ISO 8601/RFC 3339 format, UTC.)
You can specify a date with a time separated by a space.
Examples:
* ._starts_after=2025-05-15 12:00:00
* ._starts_after=2025-05-15T12:00:00Z
Filter by plan ID. Can be multiple.
Filter by plan name. Case insensitive. Supports partial matches.
Filter by Product Category ID. Can be multiple.
Filter by product category name. Case insensitive. Supports partial matches.
Filter by product ID. Can be multiple.
Returns products with the specified ID.
Examples:
* &
product_id=1
* &
product_id=1&
product_id=2
Available values:
* 1
- CDN
* 2
- Object Storage
* 3
- Web Security
* 4
- Streaming
* 5
- Cloud
* 6
- Colocation Services
* 7
- WG Private Cloud
* 8
- p2p
* 9
- DDoS Protection
* 10
- Managed DNS
* 11
- Other Services
* 12
- Premium Support
* 13
- Connectivity
* 14
- Hosting (G-Hosting)
* 15
- Managed Services
* 16
- Rent
* 17
- Software development
* 18
- VM Ware
* 19
- LaaS
* 20
- AWS Cloud
* 21
- FastEdge
* 22
- Technical Support
* 23
- WAAP
Filter by product internal name. Can be multiple.
Returns products with the specified internal name.
Examples:
* &
product_internal_name=CDN
* &
product_internal_name=CDN&
product_internal_name=DNS
Available values:
* AWS_CLOUD
- AWS Cloud
* CDN
- CDN
* CLOUD
- Cloud
* CONNECT
- Colocation Services
* CONNECTIVITY
- Connectivity
* DDOS
- Web Security
* DNS
- Managed DNS
* FAST_EDGE
- FastEdge
* GHOST
- Hosting (G-Hosting)
* INFRASTRUCTURE_PROTECTION
- DDoS Protection
* LAAS
- LaaS
* MANAGED_SERVICES
- Managed Services
* OTHER_SERVICES
- Other Services
* P2P
- p2p
* PREMIUM_SUPPORT
- Premium Support
* RENT
- Rent
* SOFTWARE_DEVELOPMENT
- Software development
* STORAGE
- Object Storage
* STREAMING
- Streaming
* TECHNICAL_SUPPORT
- Technical Support
* VMWARE
- VM Ware
* WAAP
- WAAP
* WG_PRIVATE_CLOUD
- WG Private Cloud
Filter by product name. Case insensitive. Supports partial matches.
Filter by region ID. Can be multiple.
Filter by region internal name. Can be multiple.
Filter by region internal name. Case insensitive. Supports partial matches.
Filter expenses by associated subscription IDs.