Hide response attributes Show response attributes object
-
The id of the subscription.
-
The customer id of the subscription.
-
The provider instance id of the subscription.
-
The reseller id of the subscription.
-
The friendly name of the subscription.
-
The provider subscription identifier.
-
Additional properties are NOT allowed.
-
The start date of the subscription.
-
The end date of the subscription.
-
The start date of the current term. This will change when the subscription is renewed.
-
The limit date to cancelled the subscription.
-
The quantity of the subscription.
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide nextBillingFrequency attributes Show nextBillingFrequency attributes object
-
The schedule date to change billing frequency, it is also the current billing cycle end date
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
-
The offer segment. Possible values: Commercial, Education, Government or NonProfit
Additional properties are NOT allowed.
-
Represents the action to take when a subscription reaches its end of term.
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide autoRenewSettings attributes Show autoRenewSettings attributes object
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
The quantity
-
The custom term end date
-
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.
-
The catalog promotion to check/apply at renewal, if any. Null until Domain.Subscriptions.AutoRenewSettings.ProviderPromotionId resolves against the catalog.
-
-
This value object contains the price margin for this entity.
Additional properties are NOT allowed.
Hide margin attributes Show margin attributes object
-
The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
Additional properties are NOT allowed.
-
The value applied to this price margin. Should not be below 0 or above 999.
-
-
The internal identifier.
-
The po number.
-
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.
-
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.
-
The provider promotion id. Lets the UI identify the promotion when its name could not be resolved.
-
The promotion display name. Null when the promotion could not be resolved against the catalog.
-
The discount type. (Ex.: "PercentageDiscount", etc.) Null when the promotion could not be resolved.
-
The discount value. (Ex.: 0.05, etc.) Null when the promotion could not be resolved.
-
The start of the benefit period. Null when it could not be determined.
-
The end of the benefit period. Null when it could not be determined or the term has no end.
-
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.
-
The promotion description, read from the catalog. Null when the promotion could not be resolved.
-
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
-
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.
-
The minimum number of seats the promotion applies to.
-
The maximum number of seats the promotion applies to.
-
The type of the seat constraint.
-
-
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.
-
The minimum number of owned assets required for the promotion.
-
The maximum number of owned assets allowed for the promotion.
-
The type of the asset ownership limit.
-
-
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.
-
Whether the eligibility constraint is applicable to the promotion.
-
The type of the eligibility constraint.
-
-
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.
-
The big catalog identifier of the prerequisite product.
-
View model that represents an offer the customer must already own to be eligible for a promotion.
Additional properties are NOT allowed.
-
-
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
-
View model that represents an Offer.
Additional properties are NOT allowed.
Hide offer attributes Show offer attributes object
-
The id of the offer.
-
The name of the offer.
-
The offer description.
-
The offer image URL.
-
The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
Additional properties are NOT allowed.
-
The billing type for the offer. Possible values: License, Usage or None
Additional properties are NOT allowed.
-
The offer prices.
Hide prices attributes Show prices attributes object
View model that represents an offer price.
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The offer segment. Possible values: Commercial, Education, Government or NonProfit
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide region attribute Show region attribute object
-
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.
-
-
The offer price Billing Frequencies.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
-
The offer provider name.
-
The provider's instance identifier.
-
The value indicating whether this offer is addon.
-
The minimum quantity for this offer.
-
The maximum quantity for this offer.
-
The value indicating whether this offer has pre requisite offers.
-
The list of pre requisite offers ids.
-
The value indicating whether this offer is a trial.
-
The provider's offer identifier.
-
A Value indicating whether this offer is deleted and cannot be provisioned.
-
The offer category. Possible values: ExtendedServiceTerm or EndOfSale.
Additional properties are NOT allowed.
-
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.
-
The promotion identifier in the provider.
-
The friendly name of the promotion.
-
The description of the promotion.
-
The pricing policy type of the discount.
-
The discount amount, expressed as a fraction for percent discounts.
-
The moment the promotion becomes active.
-
The moment the promotion expires.
-
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
-
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.
-
The minimum number of seats the promotion applies to.
-
The maximum number of seats the promotion applies to.
-
The type of the seat constraint.
-
-
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.
-
The minimum number of owned assets required for the promotion.
-
The maximum number of owned assets allowed for the promotion.
-
The type of the asset ownership limit.
-
-
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.
-
Whether the eligibility constraint is applicable to the promotion.
-
The type of the eligibility constraint.
-
-
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.
-
The big catalog identifier of the prerequisite product.
-
View model that represents an offer the customer must already own to be eligible for a promotion.
Additional properties are NOT allowed.
-
-
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
Whether the provider auto-applies the promotion or the partner must explicitly pass it.
-
The partner eligibility reason explaining the manual selection requirement.
-
-
Indicates whether promotions feature is enabled for the current context.
-
-
View model that represents an offer price.
Additional properties are NOT allowed.
Hide offerPrice attributes Show offerPrice attributes object
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The offer segment. Possible values: Commercial, Education, Government or NonProfit
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide region attribute Show region attribute object
-
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.
-
-
The offer price Billing Frequencies.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
-
Additional properties are NOT allowed.
-
View model that represents an Offer.
Additional properties are NOT allowed.
Hide renewOffer attributes Show renewOffer attributes object
-
The id of the offer.
-
The name of the offer.
-
The offer description.
-
The offer image URL.
-
The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.
Additional properties are NOT allowed.
-
The billing type for the offer. Possible values: License, Usage or None
Additional properties are NOT allowed.
-
The offer prices.
Hide prices attributes Show prices attributes object
View model that represents an offer price.
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The offer segment. Possible values: Commercial, Education, Government or NonProfit
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
Hide region attribute Show region attribute object
-
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.
-
-
The offer price Billing Frequencies.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
Additional properties are NOT allowed.
-
-
The offer provider name.
-
The provider's instance identifier.
-
The value indicating whether this offer is addon.
-
The minimum quantity for this offer.
-
The maximum quantity for this offer.
-
The value indicating whether this offer has pre requisite offers.
-
The list of pre requisite offers ids.
-
The value indicating whether this offer is a trial.
-
The provider's offer identifier.
-
A Value indicating whether this offer is deleted and cannot be provisioned.
-
The offer category. Possible values: ExtendedServiceTerm or EndOfSale.
Additional properties are NOT allowed.
-
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.
-
The promotion identifier in the provider.
-
The friendly name of the promotion.
-
The description of the promotion.
-
The pricing policy type of the discount.
-
The discount amount, expressed as a fraction for percent discounts.
-
The moment the promotion becomes active.
-
The moment the promotion expires.
-
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
-
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.
-
The minimum number of seats the promotion applies to.
-
The maximum number of seats the promotion applies to.
-
The type of the seat constraint.
-
-
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.
-
The minimum number of owned assets required for the promotion.
-
The maximum number of owned assets allowed for the promotion.
-
The type of the asset ownership limit.
-
-
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.
-
Whether the eligibility constraint is applicable to the promotion.
-
The type of the eligibility constraint.
-
-
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.
-
The big catalog identifier of the prerequisite product.
-
View model that represents an offer the customer must already own to be eligible for a promotion.
Additional properties are NOT allowed.
-
-
-
The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
Additional properties are NOT allowed.
-
The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
Additional properties are NOT allowed.
-
Whether the provider auto-applies the promotion or the partner must explicitly pass it.
-
The partner eligibility reason explaining the manual selection requirement.
-
-
Indicates whether promotions feature is enabled for the current context.
-
-
The subscription provider data.