Create Consumption Pool

Create Consumption Pool

URL : /api/v1/consumption-pools/

Method : POST

Parameters

• customer_account - Integer

  • required
• name - String

  • required
• code - String

  • required
  • must be unique per Customer account
• type - String

  • required
  • Choices: license, license_product_feature
• max_consumptions - Integer

  • default: 0
• total_consumptions - Integer

  • default: 0
• allow_unlimited_consumptions - Boolean

  • default: false
• allow_negative_consumptions - Boolean

  • default: true
• allow_overages - Boolean

  • default: false
• max_overages - Integer

  • default: 0
• reset_consumption - Boolean

  • default: false
• consumption_period - String

  • Choices: daily, weekly, monthly, annually
• offline_default_checkout - Integer

  • default: 0

Data example

{
    "customer_account": 811,
    "name": "Acme shared credits",
    "code": "acme-credits",
    "type": "license",
    "max_consumptions": 1000,
    "reset_consumption": true,
    "consumption_period": "monthly"
}

Success Response

Code : 201 Created

Content examples :

{
    "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
}