Retrieve a Subscription

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developer.cloudcockpit.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "CloudCockpit MCP server": {
    "url": "https://developer.cloudcockpit.com/mcp"
  }
}

Close
GET /v1/customers/{customerId}/subscriptions/{subscriptionId}

Retrieves a Subscription with the specified GUID identifier.

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. The subscription must belong to this customer, otherwise this request will fail.

  • subscriptionId string(uuid) Required

    GUID Unique identifier for the subscription.

Responses

  • OK

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

      The id of the subscription.

    • customerId string(uuid)

      The customer id of the subscription.

    • providerInstanceId string(uuid)

      The provider instance id of the subscription.

    • resellerId string(uuid) | null

      The reseller id of the subscription.

    • name string | null

      The friendly name of the subscription.

    • providerSubscriptionId string | null

      The provider subscription identifier.

    • status object

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • startDate string(date-time)

      The start date of the subscription.

    • endDate string(date-time)

      The end date of the subscription.

    • termStartDate string(date-time) | null

      The start date of the current term. This will change when the subscription is renewed.

    • cancellationAllowedUntil string(date-time) | null

      The limit date to cancelled the subscription.

    • quantity integer(int32)

      The quantity of the subscription.

    • termDuration object

      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

      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.

    • nextBillingFrequency object

      Additional properties are NOT allowed.

      Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
      • scheduledDate string(date-time) | null

        The schedule date to change billing frequency, it is also the current billing cycle end date

      • billingFrequency object

        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

      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.

    • autoRenew object

      Represents the action to take when a subscription reaches its end of term.

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • autoRenewSettings object

      Additional properties are NOT allowed.

      Hide autoRenewSettings attributes Show autoRenewSettings attributes object
      • term object Required

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

        Additional properties are NOT allowed.

        Hide term attribute Show term 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.

      • quantity integer(int32) | null Required

        The quantity

      • customTermEndDate string(date-time) | null

        The custom term end date

      • providerOfferId string | null
      • providerPromotionId string | null

        The Microsoft promotion id scheduled to apply at renewal, if any. Always persisted when Microsoft reports one, regardless of whether it resolves against the catalog.

      • promotionId string(uuid) | null

        The catalog promotion to check/apply at renewal, if any. Null until Domain.Subscriptions.AutoRenewSettings.ProviderPromotionId resolves against the catalog.

    • margin object

      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.

    • internalId string | null

      The internal identifier.

    • poNumber string | null

      The po number.

    • promotionsEnabled boolean

      Whether promotions are visible to the requesting user for this subscription. When false the active promotions section must be hidden, as opposed to shown with its empty state.

    • activePromotions array[object] | null

      The promotions currently active on the subscription. Empty when there are none or when Application.Subscriptions.ViewModels.SubscriptionViewModel.PromotionsEnabled is false.

      Hide activePromotions attributes Show activePromotions attributes object

      A promotion currently active on a subscription.

      • providerPromotionId string | null

        The provider promotion id. Lets the UI identify the promotion when its name could not be resolved.

      • name string | null

        The promotion display name. Null when the promotion could not be resolved against the catalog.

      • discountType string | null

        The discount type. (Ex.: "PercentageDiscount", etc.) Null when the promotion could not be resolved.

      • discountValue number(double) | null

        The discount value. (Ex.: 0.05, etc.) Null when the promotion could not be resolved.

      • startDate string(date-time) | null

        The start of the benefit period. Null when it could not be determined.

      • endDate string(date-time) | null

        The end of the benefit period. Null when it could not be determined or the term has no end.

      • availableAtRenewalUntil string(date-time) | null

        The date the promotion leaves the catalog, when a renewal can still apply it after the benefit period: the subscription renews to a new term and the promotion outlasts the current one. Null otherwise.

      • description string | null

        The promotion description, read from the catalog. Null when the promotion could not be resolved.

      • constraints object

        View model that represents the constraints that govern how a promotion can be redeemed.

        Additional properties are NOT allowed.

        Hide constraints attributes Show constraints attributes object
        • seatConstraints array[object] | null

          The seat count ranges the promotion supports.

          Hide seatConstraints attributes Show seatConstraints attributes object

          A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minSeats integer(int32)

            The minimum number of seats the promotion applies to.

          • maxSeats integer(int32)

            The maximum number of seats the promotion applies to.

          • type string | null

            The type of the seat constraint.

        • assetOwnershipLimits array[object] | null

          The redemption limits that cap how many times the promotion can be used.

          Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

          A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minAssets integer(int32)

            The minimum number of owned assets required for the promotion.

          • maxAssets integer(int32)

            The maximum number of owned assets allowed for the promotion.

          • type string | null

            The type of the asset ownership limit.

        • eligibilityConstraints array[object] | null

          The eligibility flags that determine whether the promotion can be redeemed.

          Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

          An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • isApplicable boolean

            Whether the eligibility constraint is applicable to the promotion.

          • type string | null

            The type of the eligibility constraint.

        • productOwnershipConstraints array[array] | null

          The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

          Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

          View model that represents a prerequisite product ownership requirement of a promotion.

          • bigId string | null

            The big catalog identifier of the prerequisite product.

          • requiredOffer object

            View model that represents an offer the customer must already own to be eligible for a promotion.

            Additional properties are NOT allowed.

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

              The offer identifier.

            • name string | null

              The offer name.

      • termDuration object

        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.

      • billingCycle object

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

        Additional properties are NOT allowed.

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

          The name of the enumeration.

    • offer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • offerPrice object

      View model that represents an offer price.

      Additional properties are NOT allowed.

      Hide offerPrice attributes Show offerPrice attributes object
      • termDuration object

        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.

      • segment object

        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.

      • region object

        Additional properties are NOT allowed.

        Hide region attribute Show region attribute object
        • value string | null

          The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

      • billingFrequencies array[object] | null

        The offer price Billing Frequencies.

        Hide billingFrequencies attribute Show billingFrequencies attribute object

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

        • name string | null

          The name of the enumeration.

      • costPrice object

        Additional properties are NOT allowed.

        Hide costPrice attributes Show costPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • revenuePrice object

        Additional properties are NOT allowed.

        Hide revenuePrice attributes Show revenuePrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • erpPrice object

        Additional properties are NOT allowed.

        Hide erpPrice attributes Show erpPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

    • unitPromotionalDiscount object

      Additional properties are NOT allowed.

      Hide unitPromotionalDiscount attributes Show unitPromotionalDiscount attributes object
      • value number(double)

        The price value.

      • currency object

        Additional properties are NOT allowed.

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

          The name of the currency.

    • renewOffer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • providerData string | null

      The subscription provider data.

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

      The id of the subscription.

    • customerId string(uuid)

      The customer id of the subscription.

    • providerInstanceId string(uuid)

      The provider instance id of the subscription.

    • resellerId string(uuid) | null

      The reseller id of the subscription.

    • name string | null

      The friendly name of the subscription.

    • providerSubscriptionId string | null

      The provider subscription identifier.

    • status object

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • startDate string(date-time)

      The start date of the subscription.

    • endDate string(date-time)

      The end date of the subscription.

    • termStartDate string(date-time) | null

      The start date of the current term. This will change when the subscription is renewed.

    • cancellationAllowedUntil string(date-time) | null

      The limit date to cancelled the subscription.

    • quantity integer(int32)

      The quantity of the subscription.

    • termDuration object

      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

      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.

    • nextBillingFrequency object

      Additional properties are NOT allowed.

      Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
      • scheduledDate string(date-time) | null

        The schedule date to change billing frequency, it is also the current billing cycle end date

      • billingFrequency object

        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

      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.

    • autoRenew object

      Represents the action to take when a subscription reaches its end of term.

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • autoRenewSettings object

      Additional properties are NOT allowed.

      Hide autoRenewSettings attributes Show autoRenewSettings attributes object
      • term object Required

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

        Additional properties are NOT allowed.

        Hide term attribute Show term 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.

      • quantity integer(int32) | null Required

        The quantity

      • customTermEndDate string(date-time) | null

        The custom term end date

      • providerOfferId string | null
      • providerPromotionId string | null

        The Microsoft promotion id scheduled to apply at renewal, if any. Always persisted when Microsoft reports one, regardless of whether it resolves against the catalog.

      • promotionId string(uuid) | null

        The catalog promotion to check/apply at renewal, if any. Null until Domain.Subscriptions.AutoRenewSettings.ProviderPromotionId resolves against the catalog.

    • margin object

      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.

    • internalId string | null

      The internal identifier.

    • poNumber string | null

      The po number.

    • promotionsEnabled boolean

      Whether promotions are visible to the requesting user for this subscription. When false the active promotions section must be hidden, as opposed to shown with its empty state.

    • activePromotions array[object] | null

      The promotions currently active on the subscription. Empty when there are none or when Application.Subscriptions.ViewModels.SubscriptionViewModel.PromotionsEnabled is false.

      Hide activePromotions attributes Show activePromotions attributes object

      A promotion currently active on a subscription.

      • providerPromotionId string | null

        The provider promotion id. Lets the UI identify the promotion when its name could not be resolved.

      • name string | null

        The promotion display name. Null when the promotion could not be resolved against the catalog.

      • discountType string | null

        The discount type. (Ex.: "PercentageDiscount", etc.) Null when the promotion could not be resolved.

      • discountValue number(double) | null

        The discount value. (Ex.: 0.05, etc.) Null when the promotion could not be resolved.

      • startDate string(date-time) | null

        The start of the benefit period. Null when it could not be determined.

      • endDate string(date-time) | null

        The end of the benefit period. Null when it could not be determined or the term has no end.

      • availableAtRenewalUntil string(date-time) | null

        The date the promotion leaves the catalog, when a renewal can still apply it after the benefit period: the subscription renews to a new term and the promotion outlasts the current one. Null otherwise.

      • description string | null

        The promotion description, read from the catalog. Null when the promotion could not be resolved.

      • constraints object

        View model that represents the constraints that govern how a promotion can be redeemed.

        Additional properties are NOT allowed.

        Hide constraints attributes Show constraints attributes object
        • seatConstraints array[object] | null

          The seat count ranges the promotion supports.

          Hide seatConstraints attributes Show seatConstraints attributes object

          A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minSeats integer(int32)

            The minimum number of seats the promotion applies to.

          • maxSeats integer(int32)

            The maximum number of seats the promotion applies to.

          • type string | null

            The type of the seat constraint.

        • assetOwnershipLimits array[object] | null

          The redemption limits that cap how many times the promotion can be used.

          Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

          A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minAssets integer(int32)

            The minimum number of owned assets required for the promotion.

          • maxAssets integer(int32)

            The maximum number of owned assets allowed for the promotion.

          • type string | null

            The type of the asset ownership limit.

        • eligibilityConstraints array[object] | null

          The eligibility flags that determine whether the promotion can be redeemed.

          Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

          An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • isApplicable boolean

            Whether the eligibility constraint is applicable to the promotion.

          • type string | null

            The type of the eligibility constraint.

        • productOwnershipConstraints array[array] | null

          The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

          Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

          View model that represents a prerequisite product ownership requirement of a promotion.

          • bigId string | null

            The big catalog identifier of the prerequisite product.

          • requiredOffer object

            View model that represents an offer the customer must already own to be eligible for a promotion.

            Additional properties are NOT allowed.

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

              The offer identifier.

            • name string | null

              The offer name.

      • termDuration object

        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.

      • billingCycle object

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

        Additional properties are NOT allowed.

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

          The name of the enumeration.

    • offer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • offerPrice object

      View model that represents an offer price.

      Additional properties are NOT allowed.

      Hide offerPrice attributes Show offerPrice attributes object
      • termDuration object

        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.

      • segment object

        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.

      • region object

        Additional properties are NOT allowed.

        Hide region attribute Show region attribute object
        • value string | null

          The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

      • billingFrequencies array[object] | null

        The offer price Billing Frequencies.

        Hide billingFrequencies attribute Show billingFrequencies attribute object

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

        • name string | null

          The name of the enumeration.

      • costPrice object

        Additional properties are NOT allowed.

        Hide costPrice attributes Show costPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • revenuePrice object

        Additional properties are NOT allowed.

        Hide revenuePrice attributes Show revenuePrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • erpPrice object

        Additional properties are NOT allowed.

        Hide erpPrice attributes Show erpPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

    • unitPromotionalDiscount object

      Additional properties are NOT allowed.

      Hide unitPromotionalDiscount attributes Show unitPromotionalDiscount attributes object
      • value number(double)

        The price value.

      • currency object

        Additional properties are NOT allowed.

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

          The name of the currency.

    • renewOffer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • providerData string | null

      The subscription provider data.

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

      The id of the subscription.

    • customerId string(uuid)

      The customer id of the subscription.

    • providerInstanceId string(uuid)

      The provider instance id of the subscription.

    • resellerId string(uuid) | null

      The reseller id of the subscription.

    • name string | null

      The friendly name of the subscription.

    • providerSubscriptionId string | null

      The provider subscription identifier.

    • status object

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • startDate string(date-time)

      The start date of the subscription.

    • endDate string(date-time)

      The end date of the subscription.

    • termStartDate string(date-time) | null

      The start date of the current term. This will change when the subscription is renewed.

    • cancellationAllowedUntil string(date-time) | null

      The limit date to cancelled the subscription.

    • quantity integer(int32)

      The quantity of the subscription.

    • termDuration object

      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

      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.

    • nextBillingFrequency object

      Additional properties are NOT allowed.

      Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
      • scheduledDate string(date-time) | null

        The schedule date to change billing frequency, it is also the current billing cycle end date

      • billingFrequency object

        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

      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.

    • autoRenew object

      Represents the action to take when a subscription reaches its end of term.

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • autoRenewSettings object

      Additional properties are NOT allowed.

      Hide autoRenewSettings attributes Show autoRenewSettings attributes object
      • term object Required

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

        Additional properties are NOT allowed.

        Hide term attribute Show term 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.

      • quantity integer(int32) | null Required

        The quantity

      • customTermEndDate string(date-time) | null

        The custom term end date

      • providerOfferId string | null
      • providerPromotionId string | null

        The Microsoft promotion id scheduled to apply at renewal, if any. Always persisted when Microsoft reports one, regardless of whether it resolves against the catalog.

      • promotionId string(uuid) | null

        The catalog promotion to check/apply at renewal, if any. Null until Domain.Subscriptions.AutoRenewSettings.ProviderPromotionId resolves against the catalog.

    • margin object

      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.

    • internalId string | null

      The internal identifier.

    • poNumber string | null

      The po number.

    • promotionsEnabled boolean

      Whether promotions are visible to the requesting user for this subscription. When false the active promotions section must be hidden, as opposed to shown with its empty state.

    • activePromotions array[object] | null

      The promotions currently active on the subscription. Empty when there are none or when Application.Subscriptions.ViewModels.SubscriptionViewModel.PromotionsEnabled is false.

      Hide activePromotions attributes Show activePromotions attributes object

      A promotion currently active on a subscription.

      • providerPromotionId string | null

        The provider promotion id. Lets the UI identify the promotion when its name could not be resolved.

      • name string | null

        The promotion display name. Null when the promotion could not be resolved against the catalog.

      • discountType string | null

        The discount type. (Ex.: "PercentageDiscount", etc.) Null when the promotion could not be resolved.

      • discountValue number(double) | null

        The discount value. (Ex.: 0.05, etc.) Null when the promotion could not be resolved.

      • startDate string(date-time) | null

        The start of the benefit period. Null when it could not be determined.

      • endDate string(date-time) | null

        The end of the benefit period. Null when it could not be determined or the term has no end.

      • availableAtRenewalUntil string(date-time) | null

        The date the promotion leaves the catalog, when a renewal can still apply it after the benefit period: the subscription renews to a new term and the promotion outlasts the current one. Null otherwise.

      • description string | null

        The promotion description, read from the catalog. Null when the promotion could not be resolved.

      • constraints object

        View model that represents the constraints that govern how a promotion can be redeemed.

        Additional properties are NOT allowed.

        Hide constraints attributes Show constraints attributes object
        • seatConstraints array[object] | null

          The seat count ranges the promotion supports.

          Hide seatConstraints attributes Show seatConstraints attributes object

          A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minSeats integer(int32)

            The minimum number of seats the promotion applies to.

          • maxSeats integer(int32)

            The maximum number of seats the promotion applies to.

          • type string | null

            The type of the seat constraint.

        • assetOwnershipLimits array[object] | null

          The redemption limits that cap how many times the promotion can be used.

          Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

          A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • minAssets integer(int32)

            The minimum number of owned assets required for the promotion.

          • maxAssets integer(int32)

            The maximum number of owned assets allowed for the promotion.

          • type string | null

            The type of the asset ownership limit.

        • eligibilityConstraints array[object] | null

          The eligibility flags that determine whether the promotion can be redeemed.

          Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

          An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

          • isApplicable boolean

            Whether the eligibility constraint is applicable to the promotion.

          • type string | null

            The type of the eligibility constraint.

        • productOwnershipConstraints array[array] | null

          The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

          Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

          View model that represents a prerequisite product ownership requirement of a promotion.

          • bigId string | null

            The big catalog identifier of the prerequisite product.

          • requiredOffer object

            View model that represents an offer the customer must already own to be eligible for a promotion.

            Additional properties are NOT allowed.

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

              The offer identifier.

            • name string | null

              The offer name.

      • termDuration object

        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.

      • billingCycle object

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

        Additional properties are NOT allowed.

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

          The name of the enumeration.

    • offer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • offerPrice object

      View model that represents an offer price.

      Additional properties are NOT allowed.

      Hide offerPrice attributes Show offerPrice attributes object
      • termDuration object

        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.

      • segment object

        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.

      • region object

        Additional properties are NOT allowed.

        Hide region attribute Show region attribute object
        • value string | null

          The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

      • billingFrequencies array[object] | null

        The offer price Billing Frequencies.

        Hide billingFrequencies attribute Show billingFrequencies attribute object

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

        • name string | null

          The name of the enumeration.

      • costPrice object

        Additional properties are NOT allowed.

        Hide costPrice attributes Show costPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • revenuePrice object

        Additional properties are NOT allowed.

        Hide revenuePrice attributes Show revenuePrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

      • erpPrice object

        Additional properties are NOT allowed.

        Hide erpPrice attributes Show erpPrice attributes object
        • value number(double)

          The price value.

        • currency object

          Additional properties are NOT allowed.

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

            The name of the currency.

    • unitPromotionalDiscount object

      Additional properties are NOT allowed.

      Hide unitPromotionalDiscount attributes Show unitPromotionalDiscount attributes object
      • value number(double)

        The price value.

      • currency object

        Additional properties are NOT allowed.

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

          The name of the currency.

    • renewOffer object

      View model that represents an Offer.

      Additional properties are NOT allowed.

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

        The id of the offer.

      • name string | null

        The name of the offer.

      • description string | null

        The offer description.

      • imageUrl string | null

        The offer image URL.

      • offerType object

        The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • billingType object

        The billing type for the offer. Possible values: License, Usage or None

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • prices array[object] | null

        The offer prices.

        Hide prices attributes Show prices attributes object

        View model that represents an offer price.

        • termDuration object

          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.

        • segment object

          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.

        • region object

          Additional properties are NOT allowed.

          Hide region attribute Show region attribute object
          • value string | null

            The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.

        • billingFrequencies array[object] | null

          The offer price Billing Frequencies.

          Hide billingFrequencies attribute Show billingFrequencies attribute object

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

          • name string | null

            The name of the enumeration.

        • costPrice object

          Additional properties are NOT allowed.

          Hide costPrice attributes Show costPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • revenuePrice object

          Additional properties are NOT allowed.

          Hide revenuePrice attributes Show revenuePrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

        • erpPrice object

          Additional properties are NOT allowed.

          Hide erpPrice attributes Show erpPrice attributes object
          • value number(double)

            The price value.

          • currency object

            Additional properties are NOT allowed.

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

              The name of the currency.

      • providerName string | null

        The offer provider name.

      • providerInstanceId string(uuid) | null

        The provider's instance identifier.

      • isAddon boolean

        The value indicating whether this offer is addon.

      • minQuantity integer(int32)

        The minimum quantity for this offer.

      • maxQuantity integer(int32)

        The maximum quantity for this offer.

      • hasPreRequisites boolean

        The value indicating whether this offer has pre requisite offers.

      • preRequisites array[string] | null

        The list of pre requisite offers ids.

      • isTrial boolean

        The value indicating whether this offer is a trial.

      • providerOfferId string | null

        The provider's offer identifier.

      • isDeleted boolean

        A Value indicating whether this offer is deleted and cannot be provisioned.

      • offerCategory object

        The offer category. Possible values: ExtendedServiceTerm or EndOfSale.

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • promotions array[object] | null

        The promotions currently available for this offer in the requested market and segment. Empty when none apply.

        Hide promotions attributes Show promotions attributes object

        View model that represents a promotion available for an offer.

        • providerPromotionId string | null

          The promotion identifier in the provider.

        • name string | null

          The friendly name of the promotion.

        • description string | null

          The description of the promotion.

        • discountType string | null

          The pricing policy type of the discount.

        • discountValue number(double)

          The discount amount, expressed as a fraction for percent discounts.

        • startDate string(date-time)

          The moment the promotion becomes active.

        • endDate string(date-time)

          The moment the promotion expires.

        • constraints object

          View model that represents the constraints that govern how a promotion can be redeemed.

          Additional properties are NOT allowed.

          Hide constraints attributes Show constraints attributes object
          • seatConstraints array[object] | null

            The seat count ranges the promotion supports.

            Hide seatConstraints attributes Show seatConstraints attributes object

            A seat count range that a promotion supports. Mirrors the Partner Center promotion seat constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minSeats integer(int32)

              The minimum number of seats the promotion applies to.

            • maxSeats integer(int32)

              The maximum number of seats the promotion applies to.

            • type string | null

              The type of the seat constraint.

          • assetOwnershipLimits array[object] | null

            The redemption limits that cap how many times the promotion can be used.

            Hide assetOwnershipLimits attributes Show assetOwnershipLimits attributes object

            A redemption limit that caps how many assets a promotion can be applied to. Mirrors the Partner Center asset ownership limit shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • minAssets integer(int32)

              The minimum number of owned assets required for the promotion.

            • maxAssets integer(int32)

              The maximum number of owned assets allowed for the promotion.

            • type string | null

              The type of the asset ownership limit.

          • eligibilityConstraints array[object] | null

            The eligibility flags that determine whether the promotion can be redeemed.

            Hide eligibilityConstraints attributes Show eligibilityConstraints attributes object

            An eligibility flag that governs whether a promotion can be redeemed (e.g. "NewToOffer"). Mirrors the Partner Center eligibility constraint shape and is persisted as part of the Domain.Promotions.PromotionConstraints JSON payload.

            • isApplicable boolean

              Whether the eligibility constraint is applicable to the promotion.

            • type string | null

              The type of the eligibility constraint.

          • productOwnershipConstraints array[array] | null

            The prerequisite product ownership requirements. The outer list is combined with AND, while each inner list is combined with OR.

            Hide productOwnershipConstraints attributes Show productOwnershipConstraints attributes object

            View model that represents a prerequisite product ownership requirement of a promotion.

            • bigId string | null

              The big catalog identifier of the prerequisite product.

            • requiredOffer object

              View model that represents an offer the customer must already own to be eligible for a promotion.

              Additional properties are NOT allowed.

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

                The offer identifier.

              • name string | null

                The offer name.

        • termDuration object

          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.

        • billingCycle object

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

          Additional properties are NOT allowed.

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

            The name of the enumeration.

        • isAutoApplicable boolean

          Whether the provider auto-applies the promotion or the partner must explicitly pass it.

        • eligibilityReason string | null

          The partner eligibility reason explaining the manual selection requirement.

      • isPromotionsEnabled boolean

        Indicates whether promotions feature is enabled for the current context.

    • providerData string | null

      The subscription provider data.

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

      Hide errors attributes Show errors attributes object

      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.

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

    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.

      Hide errors attributes Show errors attributes object

      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.

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

    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.

      Hide errors attributes Show errors attributes object

      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.

      • 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

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

      Hide errors attributes Show errors attributes object

      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.

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

    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.

      Hide errors attributes Show errors attributes object

      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.

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

    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.

      Hide errors attributes Show errors attributes object

      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.

      • 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}/subscriptions/{subscriptionId}
curl \
 --request GET 'https://api.cloudcockpit.com/v1/customers/{customerId}/subscriptions/{subscriptionId}' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"
Response examples (200)
{
  "id": "string",
  "customerId": "string",
  "providerInstanceId": "string",
  "resellerId": "string",
  "name": "string",
  "providerSubscriptionId": "string",
  "status": {
    "name": "string"
  },
  "startDate": "2026-05-04T09:42:00Z",
  "endDate": "2026-05-04T09:42:00Z",
  "termStartDate": "2026-05-04T09:42:00Z",
  "cancellationAllowedUntil": "2026-05-04T09:42:00Z",
  "quantity": 42,
  "termDuration": {
    "name": "string"
  },
  "billingFrequency": {
    "name": "string"
  },
  "nextBillingFrequency": {
    "scheduledDate": "2026-05-04T09:42:00Z",
    "billingFrequency": {
      "name": "string"
    }
  },
  "segment": {
    "name": "string"
  },
  "autoRenew": {
    "name": "string"
  },
  "autoRenewSettings": {
    "term": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "quantity": 42,
    "customTermEndDate": "2026-05-04T09:42:00Z",
    "providerOfferId": "string",
    "providerPromotionId": "string",
    "promotionId": "string"
  },
  "margin": {
    "marginRule": {
      "name": "string"
    },
    "value": 8
  },
  "internalId": "string",
  "poNumber": "string",
  "promotionsEnabled": true,
  "activePromotions": [
    {
      "providerPromotionId": "string",
      "name": "string",
      "discountType": "string",
      "discountValue": 42.0,
      "startDate": "2026-05-04T09:42:00Z",
      "endDate": "2026-05-04T09:42:00Z",
      "availableAtRenewalUntil": "2026-05-04T09:42:00Z",
      "description": "string",
      "constraints": {
        "seatConstraints": [
          {
            "minSeats": 42,
            "maxSeats": 42,
            "type": "string"
          }
        ],
        "assetOwnershipLimits": [
          {
            "minAssets": 42,
            "maxAssets": 42,
            "type": "string"
          }
        ],
        "eligibilityConstraints": [
          {
            "isApplicable": true,
            "type": "string"
          }
        ],
        "productOwnershipConstraints": [
          [
            {
              "bigId": "string",
              "requiredOffer": {
                "id": "string",
                "name": "string"
              }
            }
          ]
        ]
      },
      "termDuration": {
        "name": "string"
      },
      "billingCycle": {
        "name": "string"
      }
    }
  ],
  "offer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true,
    "offerCategory": {
      "name": "string"
    },
    "promotions": [
      {
        "providerPromotionId": "string",
        "name": "string",
        "description": "string",
        "discountType": "string",
        "discountValue": 42.0,
        "startDate": "2026-05-04T09:42:00Z",
        "endDate": "2026-05-04T09:42:00Z",
        "constraints": {
          "seatConstraints": [
            {
              "minSeats": 42,
              "maxSeats": 42,
              "type": "string"
            }
          ],
          "assetOwnershipLimits": [
            {
              "minAssets": 42,
              "maxAssets": 42,
              "type": "string"
            }
          ],
          "eligibilityConstraints": [
            {
              "isApplicable": true,
              "type": "string"
            }
          ],
          "productOwnershipConstraints": [
            [
              {
                "bigId": "string",
                "requiredOffer": {
                  "id": "string",
                  "name": "string"
                }
              }
            ]
          ]
        },
        "termDuration": {
          "name": "string"
        },
        "billingCycle": {
          "name": "string"
        },
        "isAutoApplicable": true,
        "eligibilityReason": "string"
      }
    ],
    "isPromotionsEnabled": true
  },
  "offerPrice": {
    "termDuration": {
      "name": "string"
    },
    "segment": {
      "name": "string"
    },
    "region": {
      "value": "string"
    },
    "billingFrequencies": [
      {
        "name": "string"
      }
    ],
    "costPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "revenuePrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "erpPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    }
  },
  "unitPromotionalDiscount": {
    "value": 42.0,
    "currency": {
      "name": "string"
    }
  },
  "renewOffer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true,
    "offerCategory": {
      "name": "string"
    },
    "promotions": [
      {
        "providerPromotionId": "string",
        "name": "string",
        "description": "string",
        "discountType": "string",
        "discountValue": 42.0,
        "startDate": "2026-05-04T09:42:00Z",
        "endDate": "2026-05-04T09:42:00Z",
        "constraints": {
          "seatConstraints": [
            {
              "minSeats": 42,
              "maxSeats": 42,
              "type": "string"
            }
          ],
          "assetOwnershipLimits": [
            {
              "minAssets": 42,
              "maxAssets": 42,
              "type": "string"
            }
          ],
          "eligibilityConstraints": [
            {
              "isApplicable": true,
              "type": "string"
            }
          ],
          "productOwnershipConstraints": [
            [
              {
                "bigId": "string",
                "requiredOffer": {
                  "id": "string",
                  "name": "string"
                }
              }
            ]
          ]
        },
        "termDuration": {
          "name": "string"
        },
        "billingCycle": {
          "name": "string"
        },
        "isAutoApplicable": true,
        "eligibilityReason": "string"
      }
    ],
    "isPromotionsEnabled": true
  },
  "providerData": "string"
}
Response examples (200)
{
  "id": "string",
  "customerId": "string",
  "providerInstanceId": "string",
  "resellerId": "string",
  "name": "string",
  "providerSubscriptionId": "string",
  "status": {
    "name": "string"
  },
  "startDate": "2026-05-04T09:42:00Z",
  "endDate": "2026-05-04T09:42:00Z",
  "termStartDate": "2026-05-04T09:42:00Z",
  "cancellationAllowedUntil": "2026-05-04T09:42:00Z",
  "quantity": 42,
  "termDuration": {
    "name": "string"
  },
  "billingFrequency": {
    "name": "string"
  },
  "nextBillingFrequency": {
    "scheduledDate": "2026-05-04T09:42:00Z",
    "billingFrequency": {
      "name": "string"
    }
  },
  "segment": {
    "name": "string"
  },
  "autoRenew": {
    "name": "string"
  },
  "autoRenewSettings": {
    "term": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "quantity": 42,
    "customTermEndDate": "2026-05-04T09:42:00Z",
    "providerOfferId": "string",
    "providerPromotionId": "string",
    "promotionId": "string"
  },
  "margin": {
    "marginRule": {
      "name": "string"
    },
    "value": 8
  },
  "internalId": "string",
  "poNumber": "string",
  "promotionsEnabled": true,
  "activePromotions": [
    {
      "providerPromotionId": "string",
      "name": "string",
      "discountType": "string",
      "discountValue": 42.0,
      "startDate": "2026-05-04T09:42:00Z",
      "endDate": "2026-05-04T09:42:00Z",
      "availableAtRenewalUntil": "2026-05-04T09:42:00Z",
      "description": "string",
      "constraints": {
        "seatConstraints": [
          {
            "minSeats": 42,
            "maxSeats": 42,
            "type": "string"
          }
        ],
        "assetOwnershipLimits": [
          {
            "minAssets": 42,
            "maxAssets": 42,
            "type": "string"
          }
        ],
        "eligibilityConstraints": [
          {
            "isApplicable": true,
            "type": "string"
          }
        ],
        "productOwnershipConstraints": [
          [
            {
              "bigId": "string",
              "requiredOffer": {
                "id": "string",
                "name": "string"
              }
            }
          ]
        ]
      },
      "termDuration": {
        "name": "string"
      },
      "billingCycle": {
        "name": "string"
      }
    }
  ],
  "offer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true,
    "offerCategory": {
      "name": "string"
    },
    "promotions": [
      {
        "providerPromotionId": "string",
        "name": "string",
        "description": "string",
        "discountType": "string",
        "discountValue": 42.0,
        "startDate": "2026-05-04T09:42:00Z",
        "endDate": "2026-05-04T09:42:00Z",
        "constraints": {
          "seatConstraints": [
            {
              "minSeats": 42,
              "maxSeats": 42,
              "type": "string"
            }
          ],
          "assetOwnershipLimits": [
            {
              "minAssets": 42,
              "maxAssets": 42,
              "type": "string"
            }
          ],
          "eligibilityConstraints": [
            {
              "isApplicable": true,
              "type": "string"
            }
          ],
          "productOwnershipConstraints": [
            [
              {
                "bigId": "string",
                "requiredOffer": {
                  "id": "string",
                  "name": "string"
                }
              }
            ]
          ]
        },
        "termDuration": {
          "name": "string"
        },
        "billingCycle": {
          "name": "string"
        },
        "isAutoApplicable": true,
        "eligibilityReason": "string"
      }
    ],
    "isPromotionsEnabled": true
  },
  "offerPrice": {
    "termDuration": {
      "name": "string"
    },
    "segment": {
      "name": "string"
    },
    "region": {
      "value": "string"
    },
    "billingFrequencies": [
      {
        "name": "string"
      }
    ],
    "costPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "revenuePrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    },
    "erpPrice": {
      "value": 42.0,
      "currency": {
        "name": "string"
      }
    }
  },
  "unitPromotionalDiscount": {
    "value": 42.0,
    "currency": {
      "name": "string"
    }
  },
  "renewOffer": {
    "id": "string",
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "offerType": {
      "name": "string"
    },
    "billingType": {
      "name": "string"
    },
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ],
    "providerName": "string",
    "providerInstanceId": "string",
    "isAddon": true,
    "minQuantity": 42,
    "maxQuantity": 42,
    "hasPreRequisites": true,
    "preRequisites": [
      "string"
    ],
    "isTrial": true,
    "providerOfferId": "string",
    "isDeleted": true,
    "offerCategory": {
      "name": "string"
    },
    "promotions": [
      {
        "providerPromotionId": "string",
        "name": "string",
        "description": "string",
        "discountType": "string",
        "discountValue": 42.0,
        "startDate": "2026-05-04T09:42:00Z",
        "endDate": "2026-05-04T09:42:00Z",
        "constraints": {
          "seatConstraints": [
            {
              "minSeats": 42,
              "maxSeats": 42,
              "type": "string"
            }
          ],
          "assetOwnershipLimits": [
            {
              "minAssets": 42,
              "maxAssets": 42,
              "type": "string"
            }
          ],
          "eligibilityConstraints": [
            {
              "isApplicable": true,
              "type": "string"
            }
          ],
          "productOwnershipConstraints": [
            [
              {
                "bigId": "string",
                "requiredOffer": {
                  "id": "string",
                  "name": "string"
                }
              }
            ]
          ]
        },
        "termDuration": {
          "name": "string"
        },
        "billingCycle": {
          "name": "string"
        },
        "isAutoApplicable": true,
        "eligibilityReason": "string"
      }
    ],
    "isPromotionsEnabled": true
  },
  "providerData": "string"
}
Response examples (400)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
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"
      ]
    }
  ]
}
Response examples (500)
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}