M3m3ter-com
Line Item

List Line Items

Changed on

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.

get/organizations/{orgId}/lineitems

Request

Path parameters

orgIdstring required

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

Query parameters

commitmentIdstring

Filter the line items list using the given Commitment ID.

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 for more information.

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

billIdstring

Filter the line items list using the given Bill ID.

pageSizeinteger

Number of Line Items to retrieve per page.

nextTokenstring

nextToken for multi page retrievals.

additionalstring[]

Comma separated list of additional fields.

Response

Returns list of billing line items

nextTokenstring

Changes

  • 85c514abc692Revision changes
    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from no type to object for status

  • ac93d1a9e6d9Revision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new enum value AD_HOC to the query request parameter lineItemType

    • info

      added to the / response property allOf list for the response status

    • info

      response property data/items/allOf[subschema #2 -> subschema #3]/jsonUsageGenerated deprecated