Skip to main content
GET
/
organizations
/
{orgId}
/
lineitems
List Line Items
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/lineitems \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "lineItemType": "STANDING_CHARGE",
      "productId": "<string>",
      "description": "<string>",
      "servicePeriodStartDate": "2023-11-07T05:31:56Z",
      "servicePeriodEndDate": "2023-11-07T05:31:56Z",
      "referencedBillId": "<string>",
      "referencedLineItemId": "<string>",
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>",
      "productName": "<string>",
      "productCode": "<string>",
      "accountingProductId": "<string>",
      "accountingProductName": "<string>",
      "accountingProductCode": "<string>",
      "aggregationId": "<string>",
      "compoundAggregationId": "<string>",
      "counterId": "<string>",
      "chargeId": "<string>",
      "segment": {},
      "group": {},
      "meterId": "<string>",
      "planId": "<string>",
      "planGroupId": "<string>",
      "commitmentId": "<string>",
      "balanceId": "<string>",
      "billId": "<string>",
      "quantity": 123,
      "units": 123,
      "unit": "<string>",
      "subtotal": 123,
      "currency": "<string>",
      "conversionRate": 123,
      "convertedSubtotal": 123,
      "creditTypeId": "<string>",
      "pricingId": "<string>",
      "bandUsage": [
        {
          "pricingBandId": "<string>",
          "lowerLimit": 123,
          "fixedPrice": 123,
          "unitSubtotal": 123,
          "unitPrice": 123,
          "bandUnits": 123,
          "bandQuantity": 123,
          "bandSubtotal": 123,
          "creditTypeId": "<string>",
          "convertedBandSubtotal": 123
        }
      ],
      "reasonId": "<string>",
      "contractId": "<string>",
      "jsonUsageGenerated": true,
      "averageUnitPrice": 123,
      "sequenceNumber": 123,
      "additional": {}
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
commitmentId
string

Filter the line items list using the given Commitment ID.

​
lineItemType
enum<string>

Filter the line items list using the given line item type. See Bill Line Item Types for more information on each line item type. See Bill Line Item Types for more information.

Available options:
STANDING_CHARGE,
USAGE,
COUNTER_RUNNING_TOTAL_CHARGE,
COUNTER_ADJUSTMENT_DEBIT,
COUNTER_ADJUSTMENT_CREDIT,
USAGE_CREDIT,
MINIMUM_SPEND,
MINIMUM_SPEND_REFUND,
CREDIT_DEDUCTION,
MANUAL_ADJUSTMENT,
CREDIT_MEMO,
DEBIT_MEMO,
COMMITMENT_CONSUMED,
COMMITMENT_FEE,
OVERAGE_SURCHARGE,
OVERAGE_USAGE,
BALANCE_CONSUMED,
BALANCE_FEE,
AD_HOC
​
billId
string

Filter the line items list using the given Bill ID.

​
pageSize
integer<int32>

Number of Line Items to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

nextToken for multi page retrievals.

​
additional
string[]

Comma separated list of additional fields.

Response

Returns list of billing line items

​
data
object[]
​
nextToken
string