Gets all the invoice usage line items of an invoice, using pagination.

GET /v1/Invoices/{id}/usage-lineitems

Returns a subset of the invoice usage line items of an invoice on each request. Pass the continuation token in the headers to obtain the remaining items. Available to the roles: csp

Headers

  • X-ContinuationToken string

    This header should not be set when the first page is desired. For the second page and onwards, pass the continuation token received in the response body.

  • X-Tenant string Required

    The domain used to access the portal.

  • Authorization string Required

    JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

    Default value is Bearer eyJ0eXAiO....

  • X-Correlation-Id string(UUID)

    This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

  • id string(uuid) Required

    The id of the invoice.

Query parameters

  • pageSize integer(int32) Required

    The number of items to be returned at max per page. The size can range between 1 and 2000.

Responses

  • 200

    The request completed with success and returns the line items and the continuation token (if applicable).

    Hide response attributes Show response attributes object
    • items array[object] | null

      The items in this particular seek operation.

      A model that represents a single charge of a usage invoice. In the case of the Microsoft provider each line item represents an Azure legacy charge.

      Hide items attributes Show items attributes object
      • mpnId integer(int32)

        The mpn id of the CSP.

      • resellerMpnId integer(int32) | null

        The mpn id of the reseller associated with the line item, if applicable. On tier 1 scenarios, this will be null.

      • resellerId string(uuid) | null

        The id of the reseller associated with this charge. Can be null, for example when the customer must pay directly to the CSP.

      • resellerName string | null

        The name of the reseller associated with the charge.

      • resellerInternalId string | null

        The internal id of the reseller associated with this charge.

      • customerId string(uuid) | null

        The id of the customer associated to this charge. Can be null, for example when the CSP removed the relationship with the customer on the provider side and the customer wasn't in our system when that happened.

      • customerCompanyName string | null

        The company name of the customer.

      • domainName string | null

        The domain of the customer associated with the charge.

      • customerInternalId string | null

        The internal id of the customer associated with this charge.

      • orderId string | null

        The id that identifies the order associated with the charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated with the charge. Can be null, for example when the CSP removed the relationship with the customer on the provider side and the subscription wasn't in our system when that happened.

      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • subscriptionDescription string | null

        The description of the subscription associated with the charge.

      • subscriptionInternalId string | null

        The internal id of the subscription associated with this charge.

      • offerId string(uuid) | null

        The id of the offer associated with the charge in CloudCockpit.

      • providerOfferId string | null

        The offer id on the provider's side that identifies the subscription associated with the charge.

      • offerName string | null

        The name of the offer associated with the subscription.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • chargeType string | null

        The type of charge on this line item. Possible values include:

        • Assess usage fee for current cycle: Access usage fee for the current billing period.
        • Assess usage fee when cancel: Access usage fee upon cancellation for unpaid usage during the current billing period.
      • serviceName string | null

        The name of the service associated with the line item.

      • serviceType string | null

        The type of the service associated with the line item.

      • resourceGuid string | null

        The identifier of the resource associated with the charge.

      • resourceName string | null

        The name of the resource associated with the charge.

      • region string | null

        The region associated with the charge.

      • sku string | null

        The sku associated with the charge.

      • detailLineItemId integer(int32)

        The id of the line item from the provider side.

      • consumedQuantity number(double)

        The consumed quantity of the resource.

      • overageQuantity number(double)

        The overage quantity of the line item.

      • includedQuantity number(double)

        The quantity included free of charge of the resource.

      • currency string | null

        The currency of the line item.

      • unit string | null

        The unit of charge associated with the line item, for example GB or Months.

      • listPrice number(double)

        The list price for the whole term of the subscription associated to the charge.

      • listPriceForReseller number(double) | null

        The price of each unit for reseller (with margin).

      • listPriceForCustomer number(double) | null

        The price of each unit for customer (with reseller and customer margin).

      • subtotal number(double)

        The cost before taxes for the product associated with this line item.

      • subtotalForReseller number(double) | null

        The cost the reseller pays for the subscription on this charge before taxes.

      • subtotalForCustomer number(double) | null

        The price the customer pays for the subscription on this charge before taxes.

      • taxes number(double)

        The taxes applied to the line item.

      • taxesForReseller number(double) | null

        The taxes the resellers pays for the subscription on this charge.

      • taxesForCustomer number(double) | null

        The taxes the customer pays for the subscription on this charge.

      • total number(double)

        The cost the CSP pays after taxes for this charge.

      • totalForReseller number(double) | null

        The cost the reseller pays for the subscription on this charge after taxes.

      • totalForCustomer number(double) | null

        The price the customer pays for the subscription on this charge after taxes.

      • erpProrated number(double) | null

        The actual ERP used on the charge considering if the charge is a prorated one.

      • customerProviderId string | null

        The id of customer on the provider's side associated with the charge.

      • subscriptionProviderId string | null

        The id of the subscription associated to this charge on the provider's side.

      • erpPrice number(double)

        The ERP for the whole term of the subscription associated with the charge.

      • subscriptionPONumber string | null

        The purchase order number of the subscription associated with this charge.

      • id string(uuid)

        The id that uniquely identifies a usage invoice line item.

      • billingCycleType string | null

        The type of the billing cycle. The supported value is Monthly

      • resellerPriceMargin number(double) | null

        The reseller price margin according to the ResellerPriceMarginRule.

      • resellerPriceMarginRule string | null

        The reseller price margin rule. The possible values are: markup, margin, splitmargin and erpminusdiscount.

      • customerPriceMargin number(double) | null

        The customer price margin according to the CustomerPriceMarginRule.

      • customerPriceMarginRule string | null

        The customer price margin rule. The possible values are: markup, margin, splitmargin and erpminusdiscount.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to the SubscriptionPriceMarginRule.

      • subscriptionPriceMarginRule string | null

        The subscription price margin rule. The possible values are: markup, margin, splitmargin and erpminusdiscount.

      • providerData object | null

        A dictionary that maps from strings to strings that contains specific provider invoice data.

        If this line item is associated to a Microsoft invoice then the possible values are: ResellerMpnId: The mpn id of the reseller associated with the charge. If no reseller is associated then this property is not present, example: "6286". ServiceName: The name of the service associated with the charge. For example: "Storage".

        Hide providerData attribute Show providerData attribute object | null
        • * string | null Additional properties
    • continuationToken string | null

      The token to continue to retrieve the paginated items. Should not be set if the first page of items is desired.
  • 400

    There is an error in the parameters sent in the request.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.
  • 401

    Please use a valid authorization token.

  • 403

    You don't have enough permissions to access this information.

  • 404

    The requested usage invoice does not exist. Any line items previously obtained should be discarded.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.
  • 500

    A server error has happened during the request. Please try again later or contact support.

    Hide response attributes Show response attributes object
    • statusCode integer(int32)

      The HTTP status code that represents a specific error scenario.

    • type string | null

      The type of error that occurred.

    • description string | null

      Describes the error scenario that occurred.

    • correlationId string | null

      The correlationId of the request that originated the error.
GET /v1/Invoices/{id}/usage-lineitems 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Invoices/{id}/usage-lineitems?pageSize=42' \
 --header "X-ContinuationToken: string" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"