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

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

Returns a subset of the invoice license 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 license invoice. In the case of the Microsoft provider each line item represents an License legacy charge.

      Hide items attributes Show items attributes object
      • resellerId string(uuid) | null

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

      • resellerName string | null

        The name of the reseller.

      • 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.

      • customerName string | null

        The company name 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 to the charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to 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 in CloudCockpit, associated with the line item

      • offerProviderId string | null

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

      • offerName string | null

        The name of the offer associated to the subscription.

      • subscriptionStartDate string(date-time) | null

        The start date of billing for the subscription. This value can change once a subscription renews. If it renews, then on the next invoice this property is updated too.

      • subscriptionEndDate string(date-time) | null

        The end date of the term of 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 for the Microsoft provider include:

        • Activation fee: The amount charged to the customer when they use the subscription after purchase.
        • Cancel fee: Prorated charges refunded to the customer when associated licenses are changed.
        • Cancel instance prorate: Prorated charges canceled when customer with monthly subscription has subscription suspended and associated licenses changed within the same month.
        • Cycle fee: Periodic charges for a subscription.
        • Cycle instance prorate: Prorated charges assessed from the customer when associated licenses are changed.
        • Prorate fees when cancel: Prorated refund for unused portion of service upon cancellation.
        • Prorate fees when convert away from current offering: Prorated charges after converting away from the current monthly subscription to an annual subscription.
        • Prorate fees when convert to a new offering: Prorated charges after converting a monthly subscription to a new annual subscription.
        • New purchase cycle fee: The charge type for a subscription when using both monthly or annual billing.
        • Prorate fees when purchase: The first cycle fee of a net new subscription.
        • Prorate fee when renew: The first cycle fee of a renewed subscription.
        • Prorate fees when activate: Prorated fees from reactivating suspended subscription until end of billing period.
      • unitPrice number(double)

        Price per seat, as published in the pricelist at the time of purchase.

      • unitPriceForReseller number(double) | null

        The unit price for reseller.

      • unitPriceForCustomer number(double) | null

        The unit price for customer.

      • quantity number(double)

        The billed quantity of the subscription associated to the charge.

      • amount number(double)

        The amount without taxes applied. It is equal to the Quantity * UnitPrice.

      • amountForReseller number(double) | null

        The amount for reseller without taxes applied but including discounts.

      • amountForCustomer number(double) | null

        The amount for customer without taxes applied but including discounts.

      • totalOtherDiscount number(double)

        Amount of discount applied to these charges.

      • totalOtherDiscountForReseller number(double) | null

        Amount of discount applied to these charges for reseller.

      • totalOtherDiscountForCustomer number(double) | null

        Amount of discount applied to these charges for customer

      • subtotal number(double)

        The total before taxes, with discounts applied.

      • subtotalForReseller number(double) | null

        The total before taxes for reseller, with discounts applied.

      • subtotalForCustomer number(double) | null

        The total before taxes for customer, with discounts applied.

      • total number(double)

        The total after taxes have been applied.

      • totalForReseller number(double) | null

        The total after taxes have been applied for the reseller.

      • totalForCustomer number(double) | null

        The total after taxes have been applied for the customer.

      • tax number(double)

        The tax value.

      • taxForReseller number(double) | null

        The tax value for reseller.

      • taxForCustomer number(double) | null

        The tax value for customer.

      • currency string | null

        The currency associated with the prices.

      • billingCycleType string | null

        The billing cycle of the subscription associated to the charge.

      • resellerPriceMargin number(double) | null

        The reseller price margin according to the ResellerPriceMarginRule.

      • resellerPriceMarginRule string | null

        The reseller price margin rule.

      • customerPriceMargin number(double) | null

        The customer price margin according to the CustomerPriceMarginRule.

      • customerPriceMarginRule string | null

        The customer price margin rule.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to the SubscriptionPriceMargin.

      • subscriptionPriceMarginRule string | null

        The subscription price margin rule.

      • 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: PartnerId: The tenant id of the CSP associated with the charge on Microsoft, example: "3f4b6151-7e2f-411b-984c-fe1c654c1d56". MpnId: The mpn id of the CSP associated with the charge, example: "1234", ResellerMpnId: The mpn id of the reseller associated with the charge. If no reseller is associated then this property is not present, example: "6286". DomainName: The domain of the customer associated with the charge, example: "test@pte.onmicrosoft.com".

        Hide providerData attribute Show providerData attribute object | null
        • * string | null Additional properties
      • id string(uuid)

        The id that uniquely identifies a license invoice line item.

      • erpPrice number(double)

        The ERP for the whole term of the subscription associated to the charge, at the time indicated in SubscriptionStartDate.

      • erpProrated number(double) | null

        The actual ERP used on the charge taking in to account if the charge is a prorated one. This value can be negative when we are dealing with refunds/credits.

      • customerProviderId string | null

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

      • subscriptionProviderId string | null

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

      • subscriptionPONumber string | null

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

    • 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 license 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}/license-lineitems 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Invoices/{id}/license-lineitems?pageSize=42' \
 --header "X-ContinuationToken: string" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"