v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Commitments

List commitments

get/v3/commitments

Query parameters

pagenumber

Page Number

limitnumber

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: customerId (uuid): eq, neq, in, nin, isnull, isnotnull contractId (uuid): eq, neq, in, nin, isnull, isnotnull

Example: filter=customerId:eq:00000000-0000-0000-0000-000000000001

Response

Get all commitments with optional customer and contract filtering

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "contractId": "550e8400-e29b-41d4-a716-446655440000",
        "customerId": "550e8400-e29b-41d4-a716-446655440000",
        "prepaidValue": "5000.00",
        "commitmentValue": "10000.00",
        "commitmentUnitType": "CURRENCY",
        "commitmentStartDate": "2024-01-01T00:00:00.000Z",
        "commitmentEndDate": "2024-12-31T00:00:00.000Z",
        "commitmentPeriodInterval": "MONTHLY",
        "commitmentCustomInterval": "3_MONTHS",
        "nextSequentialCommitmentId": "550e8400-e29b-41d4-a716-446655440000",
        "pricePriority": "FIRST",
        "prepaymentScheduleType": "FULL_UPFRONT",
        "eventTypesIncluded": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "API Calls"
          },
          {
            "id": "660e8400-e29b-41d4-a716-446655440001",
            "name": "Storage"
          }
        ],
        "currentCumulative": {
          "amount": "150.50",
          "units": "1000"
        },
        "periods": [
          {
            "periodId": "550e8400-e29b-41d4-a716-446655440000",
            "periodDate": "2024-01-01T00:00:00.000Z",
            "amounts": {
              "cumulative": "5000.00",
              "remaining": "5000.00",
              "trueUp": "0.00"
            },
            "eventTypes": [
              {
                "eventTypeId": "550e8400-e29b-41d4-a716-446655440000",
                "eventTypeName": "API Calls",
                "cumulative": {
                  "amount": "150.50",
                  "units": "1000"
                },
                "overages": {
                  "amount": "150.50",
                  "units": "1000"
                }
              }
            ],
            "lastCalculatedAt": "2024-01-15T10:30:00.000Z",
            "createdAt": "2024-01-01T00:00:00.000Z",
            "updatedAt": "2024-01-15T10:30:00.000Z"
          }
        ],
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-15T10:30:00.000Z",
        "trueUpBehavior": "DEFAULT",
        "schedules": [
          {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "startDate": "2024-01-01T00:00:00.000Z",
            "endDate": "2024-12-31T00:00:00.000Z",
            "steps": [
              {
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "effectiveCommitmentValue": "10000.00",
                "effectivePrepaidValue": "5000.00",
                "commitmentUnitType": "DOLLARS",
                "pricePriority": "LOW",
                "enteredAt": "2025-04-01T00:00:00.000Z"
              }
            ]
          }
        ]
      }
    ]
  }
}