Authentication Guide

Create or obtain an Api Access on the portal

The first step to use the CloudCockpit API is to create an Api Access on your portal. The creation of an Api Access is only enabled for CSPs at the moment, so if you are a Reseller or you don't have the specified permission ask a CSP to provide you with the Api Access for your user context.

Obtain an Access token from Microsoft

After the creation of the API Access you must have the corresponding client ID and client Secret, these properties are required to request an Access Token. To request access you need to perform a request to the url https://login.microsoftonline.com/4e806121-ff28-4286-ab4e-3be0a08f9ce0/oauth2/v2.0/token with the client credentials provided by the API Access.

Examples: 

curl -X POST https://login.microsoftonline.com/4e806121-ff28-4286-ab4e-3be0a08f9ce0/oauth2/v2.0/token 
-H "Content-Type: application/x-www-form-urlencoded" 
-d "client_id={ApiAccess_ClientId}&client_secret={ApiAccess_ClientSecret}&scope=api://b92a36a4-feb8-4f47-a69c-29a180aa6d0a/.default&grant_type=client_credentials"

PostmanExample

Response and Bearer Token

The response of this request will include the property access_token, and you need to copy its value and use it as the value of the Bearer token (-H "Authorization: Bearer $ACCESS_TOKEN") for each request to our API.

{
    "token_type": "Bearer",
    "expires_in": 3599,
    "ext_expires_in": 3599,
    "access_token": "eyJ0eXAiOi...."
}

AuditLogs

List all customers

GET /v1/Customers

Returns a list of your customers. The customers are returned sorted by the specified sortPropertyName. Available to the roles: csp, reseller

Headers

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

Query parameters

  • pageNumber integer(int32)

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32)

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

  • searchValue string

    The search query string. Required if searchField is provided. The search value has a maximum of 255 characters.

  • searchField string

    The field in which the search is performed. Possible values: Company.Name; Domain; InternalIdentifier and ProviderCustomerId. If searchValue was set but searchField wasn't then by default the search will be done by Company.Name.

  • sortPropertyName string

    The name of the property to sort the customers by. Possible values: Company.Name

  • ascendingOrder boolean

    if set to true [ascending order].

  • resellerId string(uuid)

    The reseller identifier. View only the customers that have relation with the specified resellerId.

  • showDeleted boolean

    If true the deleted customers will be included.

    Default value is true.

Responses

  • 200

    OK

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

      The items for this page.

      View model that represents a customer.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The GUID identifier for the customer.

      • companyName string | null Required

        The name of the company. This may be up to 255 characters.

      • taxId string | null

        The company tax Id. This may be up to 255 characters.

      • country string | null Required

        The company country code in the ISO 3166-1 alpha-2 standard.

      • addressLine1 string | null Required

        The company address line 1. This may be up to 255 characters.

      • addressLine2 string | null

        The company address line 2. This may be up to 255 characters.

      • city string | null Required

        The company city. This may be up to 255 characters.

      • state string | null Required

        The company State. This may be up to 255 characters.

      • zip string | null Required

        The company ZIP. This may be up to 30 characters.

      • firstName string | null Required

        The company primary contact first name. This may be up to 255 characters.

      • middleName string | null

        The company primary contact middle name. This may be up to 255 characters.

      • lastName string | null Required

        The company primary contact last name. This may be up to 255 characters.

      • email string | null Required

        The company primary contact email. This may be up to 255 characters.

      • phone string | null Required

        The company primary contact phone. This may be up to 30 characters.

      • internalIdentifier string | null

        The customer internal identifier. This may be up to 255 characters.

      • resellerId string(uuid) | null

        The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.

      • providerCustomers object | null Required

        The provider customers. A list containing the info about this customer in one or more provider instances.

        Hide providerCustomers attribute Show providerCustomers attribute object | null
        • * object Additional properties

          Additional properties are NOT allowed.

          Hide * attributes Show * attributes object
          • providerInstanceId string(uuid) Required

            The GUID identifier for the provider instance.

          • providerCustomerId string | null

            The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.

          • providerCustomerData string | null Required

            The provider specific data for this customer.

          • margin object Required

            This value object contains the price margin for this entity.

            Additional properties are NOT allowed.

            Hide margin attributes Show margin attributes object
            • marginRule object Required

              The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

              Additional properties are NOT allowed.

              Hide marginRule attribute Show marginRule attribute object
              • name string | null

                The name of the enumeration.

            • value number(double) | null Required

              The value applied to this price margin. Should not be below 0 or above 999.

          • offerTypeMargins object | null

            Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.

            Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
            • * object Additional properties

              This value object contains the price margin for this entity.

              Additional properties are NOT allowed.

              Hide * attributes Show * attributes object
              • marginRule object Required

                The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

                Additional properties are NOT allowed.

                Hide marginRule attribute Show marginRule attribute object
                • name string | null

                  The name of the enumeration.

              • value number(double) | null Required

                The value applied to this price margin. Should not be below 0 or above 999.

          • status object

            The status for this entity. Possible values: Processing, Success, Failed

            Additional properties are NOT allowed.

            Hide status attribute Show status attribute object
            • name string | null

              The name of the enumeration.

          • customerCreationError object

            The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown

            Additional properties are NOT allowed.

            Hide customerCreationError attribute Show customerCreationError attribute object
            • name string | null

              The name of the enumeration.

      • customerAssociations array[object] | null

        The list of partners associated to a customer

        The viewmodel for the customer relationships.

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

          The reseller id.

        • name string | null

          The name of the partner.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Additional properties are NOT allowed.

      Hide paginationParameters attributes Show paginationParameters attributes object
      • pageNumber integer(int32)

        Indicates the number of the current page.

      • pageSize integer(int32)

        The number of items that should be returned at most per page.

    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.
  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
GET /v1/Customers 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Create a customer

POST /v1/Customers

Creates a new Customer with the provided CustomerViewModel. Available to the roles: csp, reseller

Headers

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

application/json

Body

The customer info to create the customer.

  • id string(uuid)

    The GUID identifier for the customer.

  • companyName string | null Required

    The name of the company. This may be up to 255 characters.

  • taxId string | null

    The company tax Id. This may be up to 255 characters.

  • country string | null Required

    The company country code in the ISO 3166-1 alpha-2 standard.

  • addressLine1 string | null Required

    The company address line 1. This may be up to 255 characters.

  • addressLine2 string | null

    The company address line 2. This may be up to 255 characters.

  • city string | null Required

    The company city. This may be up to 255 characters.

  • state string | null Required

    The company State. This may be up to 255 characters.

  • zip string | null Required

    The company ZIP. This may be up to 30 characters.

  • firstName string | null Required

    The company primary contact first name. This may be up to 255 characters.

  • middleName string | null

    The company primary contact middle name. This may be up to 255 characters.

  • lastName string | null Required

    The company primary contact last name. This may be up to 255 characters.

  • email string | null Required

    The company primary contact email. This may be up to 255 characters.

  • phone string | null Required

    The company primary contact phone. This may be up to 30 characters.

  • internalIdentifier string | null

    The customer internal identifier. This may be up to 255 characters.

  • resellerId string(uuid) | null

    The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.

  • providerCustomers object | null Required

    The provider customers. A list containing the info about this customer in one or more provider instances.

    Hide providerCustomers attribute Show providerCustomers attribute object | null
    • * object Additional properties

      Additional properties are NOT allowed.

      Hide * attributes Show * attributes object
      • providerInstanceId string(uuid) Required

        The GUID identifier for the provider instance.

      • providerCustomerId string | null

        The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.

      • providerCustomerData string | null Required

        The provider specific data for this customer.

      • margin object Required

        This value object contains the price margin for this entity.

        Additional properties are NOT allowed.

        Hide margin attribute Show margin attribute object
        • marginRule object Required

          The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

          Additional properties are NOT allowed.

      • offerTypeMargins object | null

        Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.

        Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
        • * object Additional properties

          This value object contains the price margin for this entity.

          Additional properties are NOT allowed.

          Hide * attribute Show * attribute object
          • marginRule object Required

            The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

            Additional properties are NOT allowed.

      • status object

        The status for this entity. Possible values: Processing, Success, Failed

        Additional properties are NOT allowed.

      • customerCreationError object

        The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown

        Additional properties are NOT allowed.

  • customerAssociations array[object] | null

    The list of partners associated to a customer

    The viewmodel for the customer relationships.

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

      The reseller id.

    • name string | null

      The name of the partner.

Responses

  • 200

    OK
  • 201

    Created
  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
POST /v1/Customers 
curl \
 --request POST 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"id":"string","companyName":"string","taxId":"string","country":"PT","addressLine1":"string","addressLine2":"string","city":"string","state":"string","zip":"string","firstName":"string","middleName":"string","lastName":"string","email":"string","phone":"string","internalIdentifier":"string","resellerId":"string","providerCustomers":{"cb3cd15b-1d6e-45be-b493-c71549cbfd87":{"margin":{"value":10.6,"marginRule":{"name":"markup"}},"offerTypeMargins":{"Value":{"license":{"Value":10,"MarginRule":{"Name":"markup"}}}},"providerCustomerId":"f574cf12-a7d6-43fe-9663-1af97b04e5ab","providerInstanceId":"cb3cd15b-1d6e-45be-b493-c71549cbfd87","providerCustomerData":"{\"Domain\":\"TestDomain\",\"CredentialsEmail\":\"test@email.com\",\"AcceptedMCA\":true,\"AgreementDate\":\"2022-12-28T00:00:00Z\",\"KeepPrimaryInformation\":true,\"FirstName\":\"Test\",\"LastName\":\"Test\",\"Email\":\"test@email.com\",\"Phone\":\"921231231\",\"DefaultCulture\":\"en-US\",\"Language\":\"en\",\"AssociatedPartnerId\":null,\"Qualifications\":[],\"EnableGDAP\":true}"}},"customerAssociations":[{"resellerId":"string","name":"string"}]}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "id": "string",
  "companyName": "string",
  "taxId": "string",
  "country": "PT",
  "addressLine1": "string",
  "addressLine2": "string",
  "city": "string",
  "state": "string",
  "zip": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "internalIdentifier": "string",
  "resellerId": "string",
  "providerCustomers": {
    "cb3cd15b-1d6e-45be-b493-c71549cbfd87": {
      "margin": {
        "value": 10.6,
        "marginRule": {
          "name": "markup"
        }
      },
      "offerTypeMargins": {
        "Value": {
          "license": {
            "Value": 10,
            "MarginRule": {
              "Name": "markup"
            }
          }
        }
      },
      "providerCustomerId": "f574cf12-a7d6-43fe-9663-1af97b04e5ab",
      "providerInstanceId": "cb3cd15b-1d6e-45be-b493-c71549cbfd87",
      "providerCustomerData": "{\"Domain\":\"TestDomain\",\"CredentialsEmail\":\"test@email.com\",\"AcceptedMCA\":true,\"AgreementDate\":\"2022-12-28T00:00:00Z\",\"KeepPrimaryInformation\":true,\"FirstName\":\"Test\",\"LastName\":\"Test\",\"Email\":\"test@email.com\",\"Phone\":\"921231231\",\"DefaultCulture\":\"en-US\",\"Language\":\"en\",\"AssociatedPartnerId\":null,\"Qualifications\":[],\"EnableGDAP\":true}"
    }
  },
  "customerAssociations": [
    {
      "resellerId": "string",
      "name": "string"
    }
  ]
}

Deletes a customer from the portal.

DELETE /v1/Customers/{customerId}

Available to the roles: csp

Headers

  • 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

  • customerId string(uuid) Required

    GUID Unique identifier for the customer

Responses

  • 202

    Accepted

  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
DELETE /v1/Customers/{customerId} 
curl \
 --request DELETE 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Updates a Customer Microsoft Agreement

PATCH /v1/Customers/{customerId}/microsoft-customer-agreement

Updates the specified customer Microsoft customer agreement. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider. Available to the roles: csp, reseller

Headers

  • 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

  • customerId string(uuid) Required

    GUID Unique identifier for the customer

application/json

Body

The request body with the info to perform the update.

  • providerInstanceId string(uuid) Required

    The GUID identifier for the provider instance.

  • agreementDate string(date-time) Required

    The date this agreement was accepted by the customer.

  • keepPrimaryInformation boolean Required

    The flag indicating wheter to use the current primary contact information of the customer in the microsoft customer agreement. If true there is no need to set the properties firstName, lastName, email and phone since they will be overriden by the customer primary contact information. If set to false the earlier mentioned properties are required.

  • firstName string | null

    The first name to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If set to false this is required. This may be up to 255 characters.

  • lastName string | null

    The last name to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 255 characters.

  • email string | null

    The email to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 255 characters.

  • phone string | null

    The phone to use in this microsoft customer agreement. If KeepPrimaryInformation set to true this will be auto-populated with customer primary contact information. If KeepPrimaryInformation set to false this is required. This may be up to 30 characters.

Responses

  • 200

    OK

  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
PATCH /v1/Customers/{customerId}/microsoft-customer-agreement 
curl \
 --request PATCH 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/microsoft-customer-agreement' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"providerInstanceId":"string","agreementDate":"2025-05-04T09:42:00Z","keepPrimaryInformation":true,"firstName":"string","lastName":"string","email":"string","phone":"string"}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "agreementDate": "2025-05-04T09:42:00Z",
  "keepPrimaryInformation": true,
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string"
}

Updates a Customer Microsoft domain

PATCH /v1/Customers/{customerId}/microsoft-customer-domain

Updates the specified customer Microsoft domain. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider. This request can only be used in a provider customer that is failed with the customer creation error DomainExists. After updating the customer domain it's necessary to call the Retry Creation of a Provider Customer to attempt to create this provider customer again. Available to the roles: csp, reseller

Headers

  • 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

  • customerId string(uuid) Required

    GUID Unique identifier for the customer

application/json

Body

The request body with the info to perform the update.

  • providerInstanceId string(uuid)

    The GUID identifier for the provider instance.

  • domain string | null

    The new microsoft domain to update in this customer.

Responses

  • 204

    No Content

  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
PATCH /v1/Customers/{customerId}/microsoft-customer-domain 
curl \
 --request PATCH 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/microsoft-customer-domain' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"providerInstanceId":"string","domain":"string"}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "domain": "string"
}

Updates the roles of a customer user

PATCH /v1/Customers/{customerId}/users/{customerUserId}/user-roles

Updates the roles of a customer user. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider.

Headers

  • 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

  • customerId string(uuid) Required

    GUID Unique identifier for the customer.

  • customerUserId string(uuid) Required

    GUID Unique identifier for the customer user.

application/json

Body

The request body with the info to perform the update. This body contains an JSON Object with two properties (providerInstanceId, roleIds).

  • providerInstanceId string(uuid) Required

    The GUID identifier for the provider instance.

  • roleIds array[string(uuid)] | null Required

    The list of role Ids to assign to the customer user.

Responses

  • 200

    OK

  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
PATCH /v1/Customers/{customerId}/users/{customerUserId}/user-roles 
curl \
 --request PATCH 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/users/{customerUserId}/user-roles' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"providerInstanceId":"string","roleIds":["string"]}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "roleIds": [
    "string"
  ]
}

List all license sku Ids for a Customer user

GET /v1/Customers/{customerId}/users/{customerUserId}/licenses

Returns a list of license sku ids for a specific customer user. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider.

Headers

  • 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

  • customerId string(uuid) Required

    GUID Unique identifier for the customer.

  • customerUserId string(uuid) Required

    GUID Unique identifier for the customer user.

Query parameters

Responses

  • 200

    OK
  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
GET /v1/Customers/{customerId}/users/{customerUserId}/licenses 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/users/{customerUserId}/licenses?providerInstanceId=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Gdap

Retrieve relationship acceptance link for a Customer

GET /v1/Customers/relationship-acceptance

Gets a link to establish a relationship with a customer. If a resellerId is provided, the relationship is established between the customer and that reseller. Otherwise, the relationship is between the customer and CSP. Available to the roles: csp, reseller

Headers

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

Query parameters

  • providerInstanceId string(uuid) Required

    GUID Unique identifier for the customer.

  • resellerId string(uuid)

    GUID Unique identifier for the reseller. If user is a reseller this property will be auto-populated.

Responses

  • 200

    OK
  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Not Found

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
GET /v1/Customers/relationship-acceptance 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/relationship-acceptance?providerInstanceId=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Terminate a delegated admin relationship

POST /v1/Customers/{customerId}/delegated-admin-relationships/{relationshipId}

Available to the roles: csp

Headers

  • 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

Query parameters

  • providerInstanceId string(uuid) Required

    Id of the provider instance where relationship is being terminated

Responses

POST /v1/Customers/{customerId}/delegated-admin-relationships/{relationshipId} 
curl \
 --request POST 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/delegated-admin-relationships/{relationshipId}?providerInstanceId=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

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

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

Returns a subset of the invoice one time 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 one time invoice. In the case of the Microsoft provider this charge can be an:

      • Azure Plan,
      • Azure Savings Plan,
      • Azure Reservation,
      • New Commerce License Subscription,
      • Software Subscription,
      • Perpetual Software Subscription,
      • Marketplace Subscription.
      Hide items attributes Show items attributes object
      • resellerId string(uuid) | null

        The id of the reseller associated to this charge. Can be null.

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

      • customerName string | null

        The name of the customer.

      • customerInternalId string | null

        The internal id of the customer associated with this charge.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to the charge. Can be null.

      • subscriptionName string | null

        The name of the subscription.

      • subscriptionInternalId string | null

        The internal id of the subscription associated with this charge.

      • offerProviderId string | null

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

      • offerName string | null

        The name of the offer associated to the subscription.

      • subscriptionPONumber string | null

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

      • orderId string | null

        The id that identifies the order associated to the charge.

      • orderDate string(date-time) | null

        The date the order was placed.

      • customerCountry string | null

        The country in which the customer is located.

      • currency string | null

        The currency associated with the line item.

      • chargeType string | null

        The type of charge on this line item. Possible values for the Microsoft provider include:

        • new: When you buy a new subscription.
        • renew: When you renew your subscription.
        • cycleCharge: Regular recurring charges for your subscription.
        • addQuantity: Refunds and charges when you add seats.
        • removeQuantity: Refunds and charges when you remove seats.
        • moveQuantity: When you upgrade to an existing subscription.
        • cancelImmediate: When you cancel your subscription.
        • convert: When you change from a free trial to a paid subscription or upgrade to a new subscription.
        • changeBillingPlan: Changing from monthly to yearly billing or vice versa.
        • customerCredit: Credits for Azure, SLA, among others.
        • extendTerm: When you are given a longer trial period.
      • termAndBillingCycle string | null

        The term and billing cycle associated with this purchase.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • unitType string | null

        The type of the unit.

      • unitPrice number(double)

        The price 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 number of units purchased.

      • subtotal number(double)

        The total before taxes.

      • subtotalForReseller number(double) | null

        The total before taxes for the reseller.

      • subtotalForCustomer number(double) | null

        The total before taxes for the customer.

      • tax number(double)

        The tax value.

      • taxForReseller number(double) | null

        The tax value for the reseller.

      • taxForCustomer number(double) | null

        The tax value for the customer.

      • total number(double)

        The total after taxes.

      • totalForReseller number(double) | null

        The total for reseller after taxes.

      • totalForCustomer number(double) | null

        The total for customer after taxes.

      • id string(uuid)

        The id that uniquely identifies a one time invoice line item.

      • resellerPriceMargin number(double) | null

        The reseller price margin according to ResellerPriceMarginRule.

      • pricingCurrency string | null

        The currency of the UnitPrice, UnitPriceForReseller and UnitPriceForCustomer. This currency may differ from the invoice billing currency.

      • billingFrequency string | null

        The billing cycle of the subscription associated to the charge. Can also be empty.

      • billableQuantity number(double)

        The amount of units billed.

      • resellerPriceMarginRule string | null

        The reseller price margin rule.

      • customerPriceMargin number(double) | null

        The customer price margin according to CustomerPriceMarginRule.

      • customerPriceMarginRule string | null

        The customer price margin rule.

      • subscriptionPriceMargin number(double) | null

        The subscription price margin according to SubscriptionPriceMarginRule.

      • 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 there are a set of properties that are common to each charge: PartnerId: The tenant id of the CSP in Microsoft. CustomerDomainName: The domain of the customer. InvoiceNumber: The id of the invoice in Microsoft. MpnId: The mpn id of the CSP. ProductId: The id of the product of the line item. SkuId: The id of the sku of the line item. AvailabilityId: The id of the availability of the line item. ProductName: The name of the product. SkuName: The name of the sku. PublisherName: The name of the publisher of the sku. PublisherId: The id of the publisher of the sku. AlternateId: The alternate id. MeterDescription: The description of the meter of the line item. ReferenceId: The reference id of the line item. ProductQualifiers: Any qualifiers of the sku, such as indicating if it is a trial.

        The following properties only appear in some types of charges, see below: CustomerCountry: The country of the customer associated to the charge in two letter ISO format, example: "PT". ResellerMpnId: The mpn id of the reseller associated to the charge. If no reseller is associated then this property is not present, example: "6286". PriceAdjustmentDescription: A list of strings representing reasons for list price adjustments, for example when Partner Earned Credit is granted, example: "["Price for given term"]". If no adjustments were made then this property is not present. PCToBCExchangeRate: A decimal value used to convert the ListPrice from the pricing currency to the invoice currency, example: "0.9510675734". PCToBCExchangeRateDate: The date of the above exchange rate. CreditReasonCode: The reason for azure credits, example: "Azure Credit". EffectiveUnitPrice: The actual price billed per single quantity after the adjustments described in PriceAdjustmentDescription, example: "30.95". PromotionId: The id of the promotion that was used to bill the NCE license charge example: "39NFJQT1PGVJ:004S:39NFJQT1Q5Z1". If no promotion was applied then this property is not present. ReservationOrderId: For Azure Savings Plan this property corresponds to the savings plan order id on the Azure platform, example: "2D0D3389-D0D9-44D2-8BB4-441F5CD6D8CC". For Azure reservations this is the reservation order id, example: "8A05BC26-0542-4B6F-B97F-ECA5BAC54E9E". Term: The term applied to NCE license charges. Possible values include: "onemonth", "oneyear", "threeyears".

        For Azure plan the properties are: ResellerMpnId, PriceAdjustmentDescription, PCToBCExchangeRate, CreditReasonCode, EffectiveUnitPrice. For Azure savings plan the properties are: ResellerMpnId, PriceAdjustmentDescription, PCToBCExchangeRate, EffectiveUnitPrice, ReservationOrderId. For Azure reservation the properties are: CustomerCountry, ResellerMpnId, PriceAdjustmentDescription, PCToBCExchangeRate, EffectiveUnitPrice, CreditReasonCode, ReservationOrderId. For NCE license the properties are: CustomerCountry, ResellerMpnId, PriceAdjustmentDescription, PCToBCExchangeRate, EffectiveUnitPrice, PromotionId, Term. For software/perpetual software the properties are: CustomerCountry, ResellerMpnId, PriceAdjustmentDescription, PCToBCExchangeRate, EffectiveUnitPrice.

        Hide providerData attribute Show providerData attribute object | null
        • * string | null Additional properties
      • 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.

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

      • productType string | null

        The type of the offer associated with this charge. Possible values:

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

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"

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

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

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

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.

  • 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

  • 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 one time invoice specific for Customers. In the case of the Microsoft provider this charge can be an:

      • Azure Plan,
      • Azure Savings Plan,
      • Azure Reservation,
      • New Commerce License Subscription,
      • Software Subscription,
      • Perpetual Software Subscription,
      • Marketplace Subscription.
      Hide items attributes Show items attributes object
      • customerId string(uuid) | null

        The id of the customer associated to this charge. Can be null.

      • customerName string | null

        The company name of the customer.

      • customerCountry string | null

        The country in which the customer is located.

      • orderDate string(date-time) | null

        The date the order was placed.

      • chargeType string | null

        The type of charge on this line item. Possible values for the Microsoft provider include:

        • new: When you buy a new subscription.
        • renew: When you renew your subscription.
        • cycleCharge: Regular recurring charges for your subscription.
        • addQuantity: Refunds and charges when you add seats.
        • removeQuantity: Refunds and charges when you remove seats.
        • moveQuantity: When you upgrade to an existing subscription.
        • cancelImmediate: When you cancel your subscription.
        • convert: When you change from a free trial to a paid subscription or upgrade to a new subscription.
        • changeBillingPlan: Changing from monthly to yearly billing or vice versa.
        • customerCredit: Credits for Azure, SLA, among others.
        • extendTerm: When you are given a longer trial period.
      • quantity number(double)

        The quantity of the subscription associated to the charge.

      • currency string | null

        The currency associated with the line item.

      • subscriptionDescription string | null

        The subscription description associated with this purchase.

      • subscriptionId string(uuid) | null

        The id of the subscription associated to the charge. Can be null.

      • chargeStartDate string(date-time)

        The billing start date for this charge.

      • chargeEndDate string(date-time)

        The billing end date for this charge.

      • termAndBillingCycle string | null

        The term and billing cycle associated with this purchase.

      • unitType string | null

        The type of the unit.

      • unitPriceForCustomer number(double) | null

        The unit price for customer.

      • subtotalForCustomer number(double) | null

        The total before taxes for the customer.

      • taxTotalForCustomer number(double) | null

        The tax value for the customer.

      • totalForCustomer number(double) | null

        The total for customer after taxes.

      • id string(uuid)

        The id that uniquely identifies a one time invoice line item.

      • billableQuantity number(double)

        The amount of units billed.

      • billingFrequency string | null

        The billing frequency of the subscription associated to the charge. Can also be empty.

      • pricingCurrency string | null

        The currency of the UnitPriceForReseller and UnitPriceForCustomer. This currency may differ from the invoice billing currency.

      • productType string | null

        The type of the offer associated with this charge. Possible values:

        • license.
        • softwaresubscription.
        • perpetualsoftware.
        • azureplan.
        • azurereservation.
        • azurelegacy.
        • azuresavingsplan.
      • 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.

      • offerProviderId string | null

        The offer id on the provider's side that identifies the subscription associated to the 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.

      • subscriptionName string | null

        The friendly name of the subscription associated with this charge.

      • 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 there are a set of properties that are common to each charge: CustomerDomainName: The domain of the customer. ProductId: The id of the product of the line item. SkuId: The id of the sku of the line item. AvailabilityId: The id of the availability of the line item. ProductName: The name of the product. SkuName: The name of the sku. PublisherName: The name of the publisher of the sku. PublisherId: The id of the publisher of the sku. AlternateId: The alternate id. MeterDescription: The description of the meter of the line item.

        The following properties only appear in some types of charges, see below: ReservationOrderId: For Azure Savings Plan this property corresponds to the savings plan order id on the Azure platform, example: "2D0D3389-D0D9-44D2-8BB4-441F5CD6D8CC". For Azure reservations this is the reservation order id, example: "8A05BC26-0542-4B6F-B97F-ECA5BAC54E9E".

        For Azure savings plan the properties are: ReservationOrderId. For Azure reservation the properties are: ReservationOrderId.

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

Create an Order

POST /v1/Orders

Creates a new Order with the provided OrderViewModel and returns a model with the created order id.

Headers

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

application/json

Body

The order info to create the order.

  • id string(uuid)

    The GUID identifier for the order.

  • offerId string(uuid) Required

    The GUID identifier for the offer.

  • customerId string(uuid) Required

    The GUID identifier for the customer.

  • resellerId string(uuid) | null

    The GUID identifier for the reseller.

  • providerInstanceId string(uuid) Required

    The GUID identifier for the provider instance.

  • subscriptionName string | null Required

    The name to set in the subscription created by this order. This may be up to 255 characters.

  • termDuration object Required

    The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears

    Additional properties are NOT allowed.

  • billingFrequency object Required

    The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

    Additional properties are NOT allowed.

  • segment object Required

    The offer segment. Possible values: Commercial, Education, Government or NonProfit

    Additional properties are NOT allowed.

  • operation object Required

    The order operation type. Possible values: CreateSubscription

    Additional properties are NOT allowed.

  • quantity integer(int32) Required

    The quantity of licenses to provision for this order.

  • subscriptionMargin object

    This value object contains the price margin for this entity.

    Additional properties are NOT allowed.

    Hide subscriptionMargin attribute Show subscriptionMargin attribute object
    • marginRule object Required

      The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

      Additional properties are NOT allowed.

  • subscriptionInternalId string | null

    The internal identifier to set in the subscription created by this order. This may be up to 255 characters.

  • poNumber string | null

    The po number to set in the subscription created by this order. This may be up to 255 characters.

  • autoRenewEnabled boolean

    The flag indicating if we want to create the subscription in this order with auto renew enabled or not.

  • status object Required

    The status of the order. Possible values: Processing, Provisioning, Completed or Failed

    Additional properties are NOT allowed.

  • createdDate string(date-time)

    The date in which this order was created.

  • providerData string | null

    The provider specific data for this order. For generic provider subscriptions, this should not be set.

  • parentSubscriptionId string(uuid) | null

    The GUID identifier for the parent subscription of this order.

  • errorMessage string | null

    The error message if status is failed.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • orderId string(uuid)

      The id of the order that was created on CloudCockpit.
  • 400 application/json

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500 application/json

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
POST /v1/Orders 
curl \
 --request POST 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Orders' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"id":"string","offerId":"string","customerId":"string","resellerId":"string","providerInstanceId":"string","subscriptionName":"string","termDuration":{},"billingFrequency":{},"segment":{},"operation":{},"quantity":42,"subscriptionMargin":{"marginRule":{}},"subscriptionInternalId":"string","poNumber":"string","autoRenewEnabled":true,"status":{},"createdDate":"2025-05-04T09:42:00Z","providerData":"string","parentSubscriptionId":"string","errorMessage":"string"}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "id": "string",
  "offerId": "string",
  "customerId": "string",
  "resellerId": "string",
  "providerInstanceId": "string",
  "subscriptionName": "string",
  "termDuration": {},
  "billingFrequency": {},
  "segment": {},
  "operation": {},
  "quantity": 42,
  "subscriptionMargin": {
    "marginRule": {}
  },
  "subscriptionInternalId": "string",
  "poNumber": "string",
  "autoRenewEnabled": true,
  "status": {},
  "createdDate": "2025-05-04T09:42:00Z",
  "providerData": "string",
  "parentSubscriptionId": "string",
  "errorMessage": "string"
}
Response examples (200) 
{
  "orderId": "573b2955-f31f-4edd-9a52-0226e0b0111f"
}
Response examples (400) 
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (500) 
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

List all active Orders

GET /v1/Orders/customers/{customerId}

Returns a list of this customers active orders. This includes all orders that do not have the status Completed. The orders are returned sorted by the specified created date, with the most recent orders appearing first.

Headers

  • 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

  • customerId string(uuid) Required

    The GUID identifier for the customer.

Query parameters

  • pageNumber integer(int32)

    A cursor for pagination across multiple pages of results. The default value is 1.

  • pageSize integer(int32)

    The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.

  • sortPropertyName string

    The name of the property to sort the orders by. Currently no possible values.

  • ascendingOrder boolean

    if set to true [ascending order].

  • resellerId string(uuid)

    The GUID identifier for the reseller.

Responses

  • 200

    OK

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

      The items for this page.

      View model that represents an order.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The GUID identifier for the order.

      • offerId string(uuid) Required

        The GUID identifier for the offer.

      • customerId string(uuid) Required

        The GUID identifier for the customer.

      • resellerId string(uuid) | null

        The GUID identifier for the reseller.

      • providerInstanceId string(uuid) Required

        The GUID identifier for the provider instance.

      • subscriptionName string | null Required

        The name to set in the subscription created by this order. This may be up to 255 characters.

      • termDuration object Required

        The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears

        Additional properties are NOT allowed.

        Hide termDuration attribute Show termDuration attribute object
        • name string | null

          The name of the enumeration.

      • billingFrequency object Required

        The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

        Additional properties are NOT allowed.

        Hide billingFrequency attribute Show billingFrequency attribute object
        • name string | null

          The name of the enumeration.

      • segment object Required

        The offer segment. Possible values: Commercial, Education, Government or NonProfit

        Additional properties are NOT allowed.

        Hide segment attribute Show segment attribute object
        • name string | null

          The name of the enumeration.

      • operation object Required

        The order operation type. Possible values: CreateSubscription

        Additional properties are NOT allowed.

        Hide operation attribute Show operation attribute object
        • name string | null

          The name of the enumeration.

      • quantity integer(int32) Required

        The quantity of licenses to provision for this order.

      • subscriptionMargin object

        This value object contains the price margin for this entity.

        Additional properties are NOT allowed.

        Hide subscriptionMargin attributes Show subscriptionMargin attributes object
        • marginRule object Required

          The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

          Additional properties are NOT allowed.

          Hide marginRule attribute Show marginRule attribute object
          • name string | null

            The name of the enumeration.

        • value number(double) | null Required

          The value applied to this price margin. Should not be below 0 or above 999.

      • subscriptionInternalId string | null

        The internal identifier to set in the subscription created by this order. This may be up to 255 characters.

      • poNumber string | null

        The po number to set in the subscription created by this order. This may be up to 255 characters.

      • autoRenewEnabled boolean

        The flag indicating if we want to create the subscription in this order with auto renew enabled or not.

      • status object Required

        The status of the order. Possible values: Processing, Provisioning, Completed or Failed

        Additional properties are NOT allowed.

        Hide status attribute Show status attribute object
        • name string | null

          The name of the enumeration.

      • createdDate string(date-time)

        The date in which this order was created.

      • providerData string | null

        The provider specific data for this order. For generic provider subscriptions, this should not be set.

      • parentSubscriptionId string(uuid) | null

        The GUID identifier for the parent subscription of this order.

      • errorMessage string | null

        The error message if status is failed.

    • paginationParameters object

      A model that is used to encapsulate the parameters needed to perform pagination queries.

      Additional properties are NOT allowed.

      Hide paginationParameters attributes Show paginationParameters attributes object
      • pageNumber integer(int32)

        Indicates the number of the current page.

      • pageSize integer(int32)

        The number of items that should be returned at most per page.

    • totalPages integer(int32)

      The total number of pages available for the specified parameters and page size.

    • totalCount integer(int32)

      The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.

    • hasPreviousPage boolean

      Indicates if there is a previous page.

    • hasNextPage boolean

      Indicates if there is a next page.

    • continuationToken string | null

      The token to continue to retrieve the paginated items.
  • 400

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

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
  • 401

    Unauthorized

  • 403

    Forbidden

  • 500

    Internal Server Error

    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.

    • errors array[object] | null

      A list containing the detail of the errors that occurred in this error scenario.

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
      • propertyName string | null

        The name of the property involved in the error.

      • description array[string] | null

        A description of each error associated with the given property.
GET /v1/Orders/customers/{customerId} 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Orders/customers/{customerId}' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"