NOnovabilling
Charges

List all charges

Changed on

Retrieve all charges, optionally filtered by plan ID.

get/api/charges

Request

Query parameters

planIdstring

Filter by plan ID

Response

List of charges

idstring required
planIdstring required
billableMetricIdstring required
chargeModel'STANDARD' | 'GRADUATED' | 'VOLUME' | 'PACKAGE' | 'PERCENTAGE' required
billingTiming'IN_ADVANCE' | 'IN_ARREARS' required
invoiceDisplayNamestring
minAmountCentsnumber
proratedboolean required
propertiesobject

Model-specific config

createdAtstring required
updatedAtstring required

Example response

[
  {
    "id": "clx1234567890",
    "planId": "clxplan123",
    "billableMetricId": "clxbm123",
    "chargeModel": "GRADUATED",
    "billingTiming": "IN_ARREARS",
    "invoiceDisplayName": "API Usage",
    "minAmountCents": 100,
    "graduatedRanges": [
      {
        "id": "clx1234567890",
        "toValue": 1000,
        "perUnitAmount": "0.0100",
        "flatAmount": "0.0000"
      }
    ],
    "filters": [
      {
        "id": "clx1234567890",
        "key": "region",
        "values": [
          "us-east"
        ]
      }
    ]
  }
]

Changes