List Consumption Pools

URL : /api/v1/consumption-pools/

Method : GET

Query parameters

Ordering

• order_by - Which attribute to order the list by.

  • default ordering is ascending, can be made descending by prefixing the attribute name with -
  • Example: order_by=created_at
  • Example: order_by=-created_at

Pagination

Default pagination is 20 results per page.

• limit - Number of results to return per page.

  • Example: limit=20
• offset - The initial index from which to return the results.

  • Example: offset=21

Filtering

Possible filters:

• customer_account
• name__icontains
• type

  • values can be license, license_product_feature

Success Response

Code : 200 OK

Content examples :

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1758612345678901,
            "created_at": "2026-09-23T09:12:41.512331Z",
            "updated_at": "2026-09-23T09:12:41.512357Z",
            "name": "Acme shared credits",
            "code": "acme-credits",
            "type": "license",
            "max_consumptions": 1000,
            "total_consumptions": 0,
            "allow_unlimited_consumptions": false,
            "allow_negative_consumptions": true,
            "allow_overages": false,
            "max_overages": 0,
            "reset_consumption": true,
            "consumption_period": "monthly",
            "last_consumption_reset_at": null,
            "offline_default_checkout": 0,
            "customer_account": 811
        }
    ]
}