Zum Hauptinhalt springen

Return the AI Hosting Contract for the given Customer

GET/customers/{customerId}/ai-hosting/contract/
v2
GET
contract-get-detail-of-contract-by-ai-hosting

Request

  • customerIdstring
    required

Responses

application/json

Return the AI Hosting Contract for the given Customer.

  • additionalItemsarray of object
    • Array[
      • *object
        • activationDatestring (date-time)
        • aggregateReferenceobject
          • aggregatestring
            required
          • domainstring
            required
          • idstring
            required
        • articlesarray of object
          required
          • Array[
            • *object
              • amountinteger (≥ 1)
                required
              • articleTemplateIdstring
                required
              • descriptionstring
              • idstring
                required
              • namestring
                required
              • unitPriceobject
                required
                • currency"EUR"
                  required
                • valueinteger
                  required

                  The value of the price in the smallest currency unit (e.g. cents)

            ]
        • contractPeriodnumber (≥ 0)
          required
        • descriptionstring
          required
        • freeTrialDaysnumber
        • groupByProjectIdstring (uuid)
        • invoiceStopstring (date-time)

          If this attribute is set, the contract item will currently only be invoiced until this date.

        • invoicingPeriodnumber
        • isActivatedboolean
          required
        • isBaseItemboolean
          required
        • isInFreeTrialboolean
        • isInclusiveboolean
        • itemIdstring (uuid)
          required
        • nextPossibleDowngradeDatestring (date-time)

          If this attribute is not set, termination is not allowed.

        • nextPossibleTerminationDatestring (date-time)

          If this attribute is not set, a tariff change is not allowed.

        • nextPossibleUpgradeDatestring (date-time)

          If this attribute is not set, a tariff change is not allowed.

        • orderDatestring (date-time)
        • orderIdstring (uuid)
        • replacedByItemstring (uuid)
        • tariffChangeobject
          • newArticlesarray of object
            required
            • Array[
              • *object
                • amountinteger (≥ 1)
                  required
                • articleTemplateIdstring
                  required
                • descriptionstring
                • idstring
                  required
                • namestring
                  required
                • unitPriceobject
                  required
                  • currency"EUR"
                    required
                  • valueinteger
                    required

                    The value of the price in the smallest currency unit (e.g. cents)

              ]
          • scheduledAtDatestring (date-time)
            required
          • scheduledByUserIdstring
          • targetDatestring (date-time)
            required
        • terminationobject
          • cancellationForbiddenboolean

            Indicates whether the User is allowed to cancel the Termination.

          • explanationstring
          • reasonstring
          • scheduledAtDatestring (date-time)
            required
          • scheduledByUserIdstring
          • targetDatestring (date-time)
            required
        • totalPriceobject
          required
          • currency"EUR"
            required
          • valueinteger
            required

            The value of the price in the smallest currency unit (e.g. cents)

      ]
  • baseItemobject
    required
    • activationDatestring (date-time)
    • aggregateReferenceobject
      • aggregatestring
        required
      • domainstring
        required
      • idstring
        required
    • articlesarray of object
      required
      • Array[
        • *object
          • amountinteger (≥ 1)
            required
          • articleTemplateIdstring
            required
          • descriptionstring
          • idstring
            required
          • namestring
            required
          • unitPriceobject
            required
            • currency"EUR"
              required
            • valueinteger
              required

              The value of the price in the smallest currency unit (e.g. cents)

        ]
    • contractPeriodnumber (≥ 0)
      required
    • descriptionstring
      required
    • freeTrialDaysnumber
    • groupByProjectIdstring (uuid)
    • invoiceStopstring (date-time)

      If this attribute is set, the contract item will currently only be invoiced until this date.

    • invoicingPeriodnumber
    • isActivatedboolean
      required
    • isBaseItemboolean
      required
    • isInFreeTrialboolean
    • isInclusiveboolean
    • itemIdstring (uuid)
      required
    • nextPossibleDowngradeDatestring (date-time)

      If this attribute is not set, termination is not allowed.

    • nextPossibleTerminationDatestring (date-time)

      If this attribute is not set, a tariff change is not allowed.

    • nextPossibleUpgradeDatestring (date-time)

      If this attribute is not set, a tariff change is not allowed.

    • orderDatestring (date-time)
    • orderIdstring (uuid)
    • replacedByItemstring (uuid)
    • tariffChangeobject
      • newArticlesarray of object
        required
        • Array[
          • *object
            • amountinteger (≥ 1)
              required
            • articleTemplateIdstring
              required
            • descriptionstring
            • idstring
              required
            • namestring
              required
            • unitPriceobject
              required
              • currency"EUR"
                required
              • valueinteger
                required

                The value of the price in the smallest currency unit (e.g. cents)

          ]
      • scheduledAtDatestring (date-time)
        required
      • scheduledByUserIdstring
      • targetDatestring (date-time)
        required
    • terminationobject
      • cancellationForbiddenboolean

        Indicates whether the User is allowed to cancel the Termination.

      • explanationstring
      • reasonstring
      • scheduledAtDatestring (date-time)
        required
      • scheduledByUserIdstring
      • targetDatestring (date-time)
        required
    • totalPriceobject
      required
      • currency"EUR"
        required
      • valueinteger
        required

        The value of the price in the smallest currency unit (e.g. cents)

  • contractIdstring (uuid)
    required
  • contractNumberstring
    required
  • customerIdstring
    required
  • terminationobject
    • cancellationForbiddenboolean

      Indicates whether the User is allowed to cancel the Termination.

    • explanationstring
    • reasonstring
    • scheduledAtDatestring (date-time)
      required
    • scheduledByUserIdstring
    • targetDatestring (date-time)
      required

Usage examples

$ curl \
--fail \
--location \
-H "Authorization: Bearer $MITTWALD_API_TOKEN" \
https://api.mittwald.de/v2/customers/string/ai-hosting/contract