Sign in

v10

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

Retrieve Credit Line Item

Retrieve the Credit line item with the given UUID.

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

Path parameters

orgIdstring required

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

billIdstring required

UUID of the Bill.

idstring required

The UUID of the Credit line item to retrieve.

Response

Returns the credit line item

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.

amountnumber

The credit amount.

creditReasonIdstring

The UUID of the credit reason for this credit line item.