Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Bill

Retrieve Line Item

Retrieves a specific line item within a Bill.

This endpoint retrieves the line item given by its unique identifier (UUID) from a specific Bill.

get/organizations/{orgId}/bills/{billId}/lineitems/{id}

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

billIdstring required

The unique identifier (UUID) of the Bill containing the line item.

idstring required

The unique identifier (UUID) of the line item you want to retrieve.

Query parameters

additionalstring[]

Comma separated list of additional fields.

Response

Returns the requested line item from a Bill

idstring required

The UUID of the entity.

versioninteger

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

productIdstring
descriptionstring
servicePeriodStartDatestring date-time
servicePeriodEndDatestring date-time
referencedBillIdstring
referencedLineItemIdstring
dtCreatedstring date-time

The DateTime when the line item was created.

dtLastModifiedstring date-time

The DateTime when the line item was last modified.

createdBystring

The ID of the user who created this line item.

lastModifiedBystring

The ID of the user who last modified this line item.

productNamestring

The name of the Product associated with this line item.

productCodestring

The code of the Product associated with this line item.

accountingProductIdstring

The unique identifier (UUID) for the associated Accounting Product.

accountingProductNamestring

The name of the Accounting Product associated with this line item.

accountingProductCodestring

The code of the Accounting Product associated with this line item.

aggregationIdstring

A unique identifier (UUID) for the Aggregation that contributes to this Bill line item.

compoundAggregationIdstring

A unique identifier (UUID) for the Compound Aggregation, if applicable.

counterIdstring

The unique identifier (UUID) for the Counter associated with this line item.

chargeIdstring

The unique identifier (UUID) for the Charge associated with this line item.

segmentobject

Specifies the segment name or identifier when segmented Aggregation is used. This is relevant for more complex billing structures.

groupobject
meterIdstring

The unique identifier (UUID) of the Meter responsible for tracking usage.

planIdstring

A unique identifier (UUID) for the billing Plan associated with this line item.

planGroupIdstring

The unique identifier (UUID) of the Plan Group associated with this line item.

commitmentIdstring

The unique identifier (UUID) of the Commitment associated with this line item.

balanceIdstring

The unique identifier (UUID) for the Balance associated with this line item.

billIdstring

The unique identifier (UUID) for the Bill that includes this line item.

quantitynumber

The amount of the product or service used in this line item.

unitsnumber

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.

unitstring

Specifies the unit type. For example: MB, GB, api_calls, and so on.

subtotalnumber

The subtotal amount when not currency converted (in the cases where currency conversion is required).

currencystring

The currency in which the line item is billed, represented as a currency code. For example, USD, GBP, or EUR.

conversionRatenumber

The currency conversion rate (if used) for the line item.

convertedSubtotalnumber

The subtotal amount for this line item after currency conversion, if applicable.

creditTypeIdstring

The unique identifier (UUID) for the type of credit applied to this line item.

pricingIdstring

The unique identifier (UUID) of the Pricing used for this line item,

reasonIdstring

A unique identifier (UUID) for the reason or justification for this line item, if applicable.

contractIdstring

The unique identifier (UUID) for the Contract associated with this line item.

jsonUsageGeneratedboolean

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.

averageUnitPricenumber

Represents the average unit price calculated across all pricing bands or tiers for this line item.

sequenceNumberinteger

The line item sequence number.

additionalobject