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

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

Returns a subset of the invoice license line items of an invoice on each request for the customer. Pass the continuation token in the headers to obtain the remaining items.

Headers

  • 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

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

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

  • resellerId string(uuid)

    The id of a specific reseller. If you are a CSP you can set this to filter by reseller, otherwise don't send a value.

  • customerId string(uuid)

    The id of the customer. Use this if you are a CSP or a reseller to filter by customer. Otherwise this should be not set.

Responses

  • 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

      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
      • customerId string(uuid) | null

        The id of the customer associated with the 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.

      • orderId string | null

        The id that identifies the order associated with the charge.

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

      • offerProviderId string | null

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

      • offerName string | null

        The name of the offer associated with the charge.

      • 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.
      • quantity number(double)

        The billed quantity of the subscription associated with the charge.

      • currency string | null

        The currency associated with the prices.

      • 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: DomainName: The domain of the customer associated with the charge, example: "test@pte.onmicrosoft.com".

        Hide providerData attribute Show providerData attribute
      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The description of the subscription associated with the charge.

      • billingCycleType string | null

        The billing cycle of the subscription associated with the charge.

      • unitPriceForCustomer number(double) | null

        The price per single quantity that the customer pays.

      • amountForCustomer number(double) | null

        The amount for customer without taxes applied but including discounts.

      • subtotalForCustomer number(double) | null

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

      • taxForCustomer number(double) | null

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

      • totalForCustomer number(double) | null

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

      • totalOtherDiscountForCustomer number(double) | null

        The discount the customer receives for the subscription on this charge.

      • id string(uuid)

        The id that uniquely identifies a license invoice line item.

      • The purchase order number of the subscription associated with the 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.

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

      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
      • customerId string(uuid) | null

        The id of the customer associated with the 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.

      • orderId string | null

        The id that identifies the order associated with the charge.

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

      • offerProviderId string | null

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

      • offerName string | null

        The name of the offer associated with the charge.

      • 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.
      • quantity number(double)

        The billed quantity of the subscription associated with the charge.

      • currency string | null

        The currency associated with the prices.

      • 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: DomainName: The domain of the customer associated with the charge, example: "test@pte.onmicrosoft.com".

        Hide providerData attribute Show providerData attribute
      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The description of the subscription associated with the charge.

      • billingCycleType string | null

        The billing cycle of the subscription associated with the charge.

      • unitPriceForCustomer number(double) | null

        The price per single quantity that the customer pays.

      • amountForCustomer number(double) | null

        The amount for customer without taxes applied but including discounts.

      • subtotalForCustomer number(double) | null

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

      • taxForCustomer number(double) | null

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

      • totalForCustomer number(double) | null

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

      • totalOtherDiscountForCustomer number(double) | null

        The discount the customer receives for the subscription on this charge.

      • id string(uuid)

        The id that uniquely identifies a license invoice line item.

      • The purchase order number of the subscription associated with the 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.

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

      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
      • customerId string(uuid) | null

        The id of the customer associated with the 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.

      • orderId string | null

        The id that identifies the order associated with the charge.

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

      • offerProviderId string | null

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

      • offerName string | null

        The name of the offer associated with the charge.

      • 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.
      • quantity number(double)

        The billed quantity of the subscription associated with the charge.

      • currency string | null

        The currency associated with the prices.

      • 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: DomainName: The domain of the customer associated with the charge, example: "test@pte.onmicrosoft.com".

        Hide providerData attribute Show providerData attribute
      • subscriptionName string | null

        The name of the subscription associated with the charge.

      • The description of the subscription associated with the charge.

      • billingCycleType string | null

        The billing cycle of the subscription associated with the charge.

      • unitPriceForCustomer number(double) | null

        The price per single quantity that the customer pays.

      • amountForCustomer number(double) | null

        The amount for customer without taxes applied but including discounts.

      • subtotalForCustomer number(double) | null

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

      • taxForCustomer number(double) | null

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

      • totalForCustomer number(double) | null

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

      • totalOtherDiscountForCustomer number(double) | null

        The discount the customer receives for the subscription on this charge.

      • id string(uuid)

        The id that uniquely identifies a license invoice line item.

      • The purchase order number of the subscription associated with the 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.

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

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
  • 401

    Please use a valid authorization token.

  • 403

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

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

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
  • A server error has happened during the request. Please try again later or contact support.

    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
    Hide response attributes Show response attributes object
GET /v1/Invoices/{id}/customer-license-lineitems
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Invoices/{id}/customer-license-lineitems?pageSize=42 \
 -H "X-ContinuationToken: string" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200)
{
  "items": [
    {
      "customerId": "2C741C83-E111-4A77-BC5F-C2F065275FA9",
      "customerName": "CloudCockpit",
      "orderId": "569423888785251957",
      "subscriptionProviderId": "FA2A91FD-7286-4DCD-9718-20048CCA832A",
      "offerProviderId": "B4D4B7F4-4089-43B6-9C44-DE97B760FB11",
      "offerName": "Visio Plan 2",
      "subscriptionStartDate": "2021-07-21T00:00:00",
      "subscriptionEndDate": "2024-07-20T00:00:00",
      "chargeStartDate": "2022-12-21T00:00:00",
      "chargeEndDate": "2023-01-20T00:00:00",
      "chargeType": "Cycle fee",
      "quantity": 2,
      "currency": "EUR",
      "providerData": {
        "DomainName": "test@pte.onmicrosoft.com"
      },
      "subscriptionName": "Microsoft 365 Business Standard",
      "subscriptionDescription": "Microsoft 365 Business Standard",
      "billingCycleType": "Monthly",
      "unitPriceForCustomer": 13.11,
      "amountForCustomer": -7.45,
      "subtotalForCustomer": 50.12,
      "taxForCustomer": 7.25,
      "totalForCustomer": 57.31,
      "totalOtherDiscountForCustomer": 1.1,
      "id": "7828D90D-2AC6-4F20-A95B-EE850BCD32A0",
      "subscriptionPONumber": "8543943821"
    }
  ],
  "continuationToken": "string"
}
Response examples (200)
{
  "items": [
    {
      "customerId": "2C741C83-E111-4A77-BC5F-C2F065275FA9",
      "customerName": "CloudCockpit",
      "orderId": "569423888785251957",
      "subscriptionProviderId": "FA2A91FD-7286-4DCD-9718-20048CCA832A",
      "offerProviderId": "B4D4B7F4-4089-43B6-9C44-DE97B760FB11",
      "offerName": "Visio Plan 2",
      "subscriptionStartDate": "2021-07-21T00:00:00",
      "subscriptionEndDate": "2024-07-20T00:00:00",
      "chargeStartDate": "2022-12-21T00:00:00",
      "chargeEndDate": "2023-01-20T00:00:00",
      "chargeType": "Cycle fee",
      "quantity": 2,
      "currency": "EUR",
      "providerData": {
        "DomainName": "test@pte.onmicrosoft.com"
      },
      "subscriptionName": "Microsoft 365 Business Standard",
      "subscriptionDescription": "Microsoft 365 Business Standard",
      "billingCycleType": "Monthly",
      "unitPriceForCustomer": 13.11,
      "amountForCustomer": -7.45,
      "subtotalForCustomer": 50.12,
      "taxForCustomer": 7.25,
      "totalForCustomer": 57.31,
      "totalOtherDiscountForCustomer": 1.1,
      "id": "7828D90D-2AC6-4F20-A95B-EE850BCD32A0",
      "subscriptionPONumber": "8543943821"
    }
  ],
  "continuationToken": "string"
}
Response examples (400)
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (400)
{
  "statusCode": 400,
  "type": "ValidationException",
  "description": "Validation failed: \n -- PageSize: The page size must be between 1 and 2000 Severity: Error",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (404)
{
  "statusCode": 404,
  "type": "EntityNotFoundException",
  "description": "No providers found for the tenant.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (404)
{
  "statusCode": 404,
  "type": "EntityNotFoundException",
  "description": "No providers found for the tenant.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500)
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}
Response examples (500)
{
  "statusCode": 500,
  "type": "NullReferenceException",
  "description": "An error happened processing your request. Please contact support.",
  "correlationId": "685043EA-6D49-4ACE-8BDB-CCE9D3E2DBD0"
}