Manage orders - Get growth margin by id

Service:

Partner Center Rest

API Version:

v1

Gets a single growth margin by ID and country or region.
Retrieves a single growth margin for a given growth margin ID and country or region, ignoring the growth margin start and end dates. This operation is used primarily for reconciliation to retrieve growth margin details after the growth margin expires.

GET https://api.partnercenter.microsoft.com/v1/catalog/benefits/{growth-margin-id}?country={country}

URI Parameters

Name	In	Required	Type	Description
growth-margin-id	path	True	string	A string defining the growth margin to retrieve.
country	query	True	string	A two-letter country code determining which customer country or region growth margins are available for.

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization ******
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
MS-CV		string	Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request
X-Locale		string	The locale to use for localized response content, such as en-US.
Accept	True	string	Typically application/json.

Responses

Name	Type	Description
200 OK	GrowthMarginBenefit	The request was successful. The response body contains the growth margin. Media Types: "application/json", "text/json"

Definitions

Name	Description
AssetOwnershipLimit	The asset ownership limits.
BenefitProductPolicy	The pricing, offer, and eligibility policies that define the growth margin.
BenefitRequiredProduct	The base product purchase configurations to which the growth margin can apply.
ConstraintsData	The constraints associated with the eligibility policy.
Eligibility	The eligibility details associated with the policy.
EligibilityConstraint	The eligibility constraints.
EligibilityPolicy	The eligibility rule sets for the growth margin.
EligibilityPolicyData	The data associated with the eligibility policy.
GrowthMarginBenefit	Represents a growth margin benefit resource.
OfferPolicy	The offer rules that define the growth margin availability period and beneficiary.
OfferPolicyData	The data associated with the offer policy.
OfferPolicyProperties	The properties associated with the offer policy.
PartnerConstraint	The partner constraints.
PricingPolicy	The pricing rules for the growth margin.
PricingPolicyBenefit	The benefits provided by the pricing policy.
PricingPolicyData	The data associated with the pricing policy.
ProductOwnershipConstraint	Groups of product ownership constraints.
PurchaseRequirementConstraint	The purchase requirement constraints.
SeatConstraint	The seat constraints.
SkuProductCode	The product code identities for the growth margin.

AssetOwnershipLimit

Object

The asset ownership limits.

Name	Type	Description
maxAssets	integer (int32)	The maximum number of owned assets.
minAssets	integer (int32)	The minimum number of owned assets.
type	string	The asset ownership limit type.

BenefitProductPolicy

Object

The pricing, offer, and eligibility policies that define the growth margin.

Name	Type	Description
eligibilityPolicies	EligibilityPolicy[]	The eligibility rule sets for the growth margin.
offerPolicies	OfferPolicy[]	The offer rules that define the growth margin availability period and beneficiary.
pricingPolicies	PricingPolicy[]	The pricing rules for the growth margin.

BenefitRequiredProduct

Object

The base product purchase configurations to which the growth margin can apply.

Name	Type	Description
billingCycle	string	The applicable base-product billing cycle, such as Monthly or Annual.
productId	string	The product identifier of an applicable base product.
skuId	string	The SKU identifier of an applicable base product. Leading zeros are significant.
termDuration	string	The applicable base-product term in ISO 8601 duration format, such as P1Y.

ConstraintsData

Object

The constraints associated with the eligibility policy.

Name	Type	Description
assetOwnershipLimits	AssetOwnershipLimit[]	The asset ownership limits.
eligibilityConstraints	EligibilityConstraint[]	The eligibility constraints.
partnerConstraints	PartnerConstraint[]	The partner constraints.
prerequisiteConstraints	api.partnercenter.microsoft.com.partner-center.manageorders.getgrowthmarginbyid	Prerequisite constraints returned as an untyped JSON value.
productOwnershipConstraints	ProductOwnershipConstraint[]	Groups of product ownership constraints.
purchaseRequirementConstraints	PurchaseRequirementConstraint[]	The purchase requirement constraints.
seatConstraints	SeatConstraint[]	The seat constraints.

Eligibility

Object

The eligibility details associated with the policy.

Name	Type	Description
constraintsData	ConstraintsData	The constraints associated with the eligibility policy.
dynamicPurchaseConstraint	api.partnercenter.microsoft.com.partner-center.manageorders.getgrowthmarginbyid	A dynamic purchase constraint returned as an untyped JSON value.

EligibilityConstraint

Object

The eligibility constraints.

Name	Type	Description
isApplicable	boolean	Whether the eligibility constraint is applicable.
type	string	The eligibility constraint type.

EligibilityPolicy

Object

The eligibility rule sets for the growth margin.

Name	Type	Description
policyData	EligibilityPolicyData	The data associated with the eligibility policy.
policyId	string	The eligibility policy identifier.

EligibilityPolicyData

Object

The data associated with the eligibility policy.

Name	Type	Description
eligibility	Eligibility	The eligibility details associated with the policy.

GrowthMarginBenefit

Object

Represents a growth margin benefit resource.

Name	Type	Description
description	string	The description of the growth margin.
id	string	The catalog identifier for the growth margin discount product and pricing point, in productId:skuId:availabilityId format.
name	string	The display name of the growth margin.
productCodes	SkuProductCode[]	The product code identities for the growth margin.
productPolicy	BenefitProductPolicy	The pricing, offer, and eligibility policies that define the growth margin.
requiredProducts	BenefitRequiredProduct[]	The base product purchase configurations to which the growth margin can apply.

OfferPolicy

Object

The offer rules that define the growth margin availability period and beneficiary.

Name	Type	Description
policyData	OfferPolicyData	The data associated with the offer policy.
policyId	string	The offer policy identifier.

OfferPolicyData

Object

The data associated with the offer policy.

Name	Type	Description
beneficiary	string	The beneficiary of the offer.
isOptional	boolean	Whether the offer is optional.
properties	OfferPolicyProperties	The properties associated with the offer policy.

OfferPolicyProperties

Object

The properties associated with the offer policy.

Name	Type	Description
endDate	string	The end date of the offer.
startDate	string	The start date of the offer.

PartnerConstraint

Object

The partner constraints.

Name	Type	Description
isApplicable	boolean	Whether the partner constraint is applicable.
type	string	The partner constraint type.

PricingPolicy

Object

The pricing rules for the growth margin.

Name	Type	Description
policyData	PricingPolicyData	The data associated with the pricing policy.
policyId	string	The pricing policy identifier.

PricingPolicyBenefit

Object

The benefits provided by the pricing policy.

Name	Type	Description
type	string	The pricing benefit type, such as PercentDiscount.
value	number (double)	The pricing benefit value.

PricingPolicyData

Object

The data associated with the pricing policy.

Name	Type	Description
benefits	PricingPolicyBenefit[]	The benefits provided by the pricing policy.

ProductOwnershipConstraint

Object

Groups of product ownership constraints.

Name	Type	Description
bigId	string	The big catalog identifier.
maxSeats	integer (int32)	The optional maximum number of seats.
minSeats	integer (int32)	The optional minimum number of seats.

PurchaseRequirementConstraint

Object

The purchase requirement constraints.

Name	Type	Description
bigId	string	The big catalog identifier.
maxSeats	integer (int32)	The maximum number of seats.
minSeats	integer (int32)	The minimum number of seats.
termDuration	string	The term duration.
type	string	The purchase requirement constraint type.

SeatConstraint

Object

The seat constraints.

Name	Type	Description
maxSeats	integer (int32)	The maximum number of seats.
minSeats	integer (int32)	The minimum number of seats.
seatIncreaseMultiplier	integer (int32)	The seat increase multiplier.
type	string	The seat constraint type.

SkuProductCode

Object

The product code identities for the growth margin.

Name	Type	Description
productCode	string	The product code value.
termId	string	The term identifier associated with the product code.