--- title: "List Line Items" method: GET path: "/organizations/{orgId}/lineitems" tags: ["Line Item"] --- # List Line Items `GET /organizations/{orgId}/lineitems` List the billing line items for the given Organization, which can be filtered by the type of line item, Bill ID, or Commitment *(prepayment)* ID. ## Path parameters - `orgId` string, required ## Query parameters - `commitmentId` string - `lineItemType` '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' — See [Bill Line Item Types](https://www.m3ter.com/docs/guides/running-viewing-and-managing-bills/bill-line-item-types) for more information. - `billId` string - `pageSize` integer - `nextToken` string - `additional` string[] ## Response `200` Returns list of billing line items - PaginatedBillLineItemResponseData - `data` BillLineItemResponse[] - `id` string, required — The UUID of the entity. - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response. - `lineItemType` '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' — See [Bill Line Item Types](https://www.m3ter.com/docs/guides/running-viewing-and-managing-bills/bill-line-item-types) for more information. - `productId` string - `description` string - `servicePeriodStartDate` string, date-time - `servicePeriodEndDate` string, date-time - `referencedBillId` string - `referencedLineItemId` string - `dtCreated` string, date-time — The DateTime when the line item was created. - `dtLastModified` string, date-time — The DateTime when the line item was last modified. - `createdBy` string — The ID of the user who created this line item. - `lastModifiedBy` string — The ID of the user who last modified this line item. - `productName` string — The name of the Product associated with this line item. - `productCode` string — The code of the Product associated with this line item. - `accountingProductId` string — The unique identifier (UUID) for the associated Accounting Product. - `accountingProductName` string — The name of the Accounting Product associated with this line item. - `accountingProductCode` string — The code of the Accounting Product associated with this line item. - `aggregationId` string — A unique identifier (UUID) for the Aggregation that contributes to this Bill line item. - `compoundAggregationId` string — A unique identifier (UUID) for the Compound Aggregation, if applicable. - `counterId` string — The unique identifier (UUID) for the Counter associated with this line item. - `chargeId` string — The unique identifier (UUID) for the Charge associated with this line item. - `segment` object — Specifies the segment name or identifier when segmented Aggregation is used. This is relevant for more complex billing structures. - `group` object - `meterId` string — The unique identifier (UUID) of the Meter responsible for tracking usage. - `planId` string — A unique identifier (UUID) for the billing Plan associated with this line item. - `planGroupId` string — The unique identifier (UUID) of the Plan Group associated with this line item. - `commitmentId` string — The unique identifier (UUID) of the Commitment associated with this line item. - `balanceId` string — The unique identifier (UUID) for the Balance associated with this line item. - `billId` string — The unique identifier (UUID) for the Bill that includes this line item. - `quantity` number — The amount of the product or service used in this line item. - `units` number — The number of units rated in the line item, each of which is of the type specified in the `unit` field. For example: 400 api_calls. In this example, the unit type of **api_calls** is read from the `unit` field. - `unit` string — Specifies the unit type. For example: **MB**, **GB**, **api_calls**, and so on. - `subtotal` number — The subtotal amount when not currency converted *(in the cases where currency conversion is required)*. - `currency` string — The currency in which the line item is billed, represented as a currency code. For example, USD, GBP, or EUR. - `conversionRate` number — The currency conversion rate *(if used)* for the line item. - `convertedSubtotal` number — The subtotal amount for this line item after currency conversion, if applicable. - `creditTypeId` string — The unique identifier (UUID) for the type of credit applied to this line item. - `pricingId` string — The unique identifier (UUID) of the Pricing used for this line item, - `bandUsage` BillLineItemPricingBandUsage[] — Array containing the pricing band information, which shows the details for each pricing band or tier. - `pricingBandId` string — The UUID for the pricing band. - `lowerLimit` number, double — The lower limit *(start)* of the pricing band. - `fixedPrice` number — Fixed price is a charge entered for certain pricing types such as Stairstep, Custom Tiered, and Custom Volume. It is a set price and not dependent on usage. - `unitSubtotal` number — The subtotal of the unit usage. - `unitPrice` number — The price per unit in the band. - `bandUnits` number — The number of units used within the band. - `bandQuantity` number — Usage amount within the band. - `bandSubtotal` number — Subtotal amount for the band. - `creditTypeId` string — The UUID of the credit type. - `convertedBandSubtotal` number - `reasonId` string — A unique identifier (UUID) for the reason or justification for this line item, if applicable. - `contractId` string — The unique identifier (UUID) for the Contract associated with this line item. - `jsonUsageGenerated` boolean — Boolean flag indicating whether the Bill line item has associated statement usage in JSON format. When a Bill statement is generated, usage line items have their usage stored in JSON format. - `averageUnitPrice` number — Represents the average unit price calculated across all pricing bands or tiers for this line item. - `sequenceNumber` integer — The line item sequence number. - `additional` object - `nextToken` string ## Other responses - `4XX` — Error message - `5XX` — Error message --- [API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/revisions/ac93d1a9e6d9/schema)