Offer
Response Model for an Offer
Properties
A Map<String, String> that holds extra information about the offer
Billing frequency of the offer
Possible values are: PREPAID , MONTHLY , ANNUAL
The offer billing model based on supported models
Possible values are: COMMIT_REQUIRED , COMMIT_OPTIONAL , COMMIT_ONLY
Offer billing term, applicable only for COMMIT
Offer charge id, Applicable only for COMMIT
Currency used to purchase the offer
Offer description from billing engine
End date time of the offer
Shared Cloud or Managed hosting type
License Unit of the offer
Given name of the offer
Category of the offer such as Primary, Addon or Onetime
Possible values are: PRIMARY , ADDON , ONETIME
Type of Offer such as On-Demand or Commit
Possible values are: ONDEMAND , COMMIT
Globally unique product id for the offer
Program eligibility such as Subscription Upgrade
Quantity for purchase. Applicable only for COMMIT
Purchase quantity Unit Of Measurement
Reference ID of the offer
The region for which the offer is valid
SKU of the offer based on the offer attributes
Start date time of the offer
Lifecycle status of the offer
Possible values are: SUBMITTED , PENDING_PROVISIONING , ERROR , ACTIVE , PENDING_CANCEL , CANCELLED , TERMINATED , PENDING_ACTIVE , EXPIRED
Level of support available for the offer
Tier name. Tier attributes will be populated in case of tier volume pricing. Applicable only when chargeType is TIERED
The usage submission variants applicable for models that support usage
JSON Example
{
"additionalAttributes": {
"key": "string"
},
"billingFrequency": "PREPAID",
"billingModel": "COMMIT_REQUIRED",
"billingTerm": 0,
"chargeId": "string",
"components": [
{
"description": "string",
"productFamily": "string",
"productId": "string",
"quantity": 0
}
],
"currency": "string",
"description": "string",
"endDate": "string",
"hostingType": "string",
"licenseUnit": "string",
"name": "string",
"offerCategory": "PRIMARY",
"offerCost": {
"creditSavings": [
{
"creditAmount": 0,
"creditReference": "string",
"type": "FLEX_EXCHANGE"
}
],
"discountSavings": [
{
"attributes": {
"key": "string"
},
"discountAmount": 0,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": 0,
"promotionCode": "string",
"promotionName": "string",
"promotionPercent": 0,
"promotionServiceDetails": [
{
"description": "string",
"productFamily": "string",
"serviceDefinitionId": "string"
}
],
"promotionType": "PromotionSaving",
"remainingAmount": 0,
"sellerPromotionInstanceId": "string"
}
],
"remainingContractValue": 0,
"totalContractValue": 0,
"totalCreditSavings": 0,
"totalDiscountSavings": 0,
"totalListPrice": 0,
"totalNetPrice": 0,
"totalPromotionSavings": 0,
"totalSalePrice": 0,
"unitListPrice": 0,
"unitNetPrice": 0,
"unitTotalContractValue": 0
},
"offerType": "ONDEMAND",
"productId": "string",
"programOption": "string",
"purchaseQuantity": 0,
"quantityUom": "string",
"referenceId": "string",
"region": "string",
"serviceRef": {
"id": "string",
"name": "string",
"serviceIcon": "string"
},
"sku": "string",
"startDate": "string",
"status": "SUBMITTED",
"supportLevel": "string",
"tierName": "string",
"usageItems": [
{
"chargeId": "string",
"chargeType": "string",
"name": "string",
"offerCost": {
"creditSavings": [
{
"creditAmount": 0,
"creditReference": "string",
"type": "FLEX_EXCHANGE"
}
],
"discountSavings": [
{
"attributes": {
"key": "string"
},
"discountAmount": 0,
"type": "RCD"
}
],
"promotionSavings": [
{
"promotionAmount": 0,
"promotionCode": "string",
"promotionName": "string",
"promotionPercent": 0,
"promotionServiceDetails": [
{
"description": "string",
"productFamily": "string",
"serviceDefinitionId": "string"
}
],
"promotionType": "PromotionSaving",
"remainingAmount": 0,
"sellerPromotionInstanceId": "string"
}
],
"remainingContractValue": 0,
"totalContractValue": 0,
"totalCreditSavings": 0,
"totalDiscountSavings": 0,
"totalListPrice": 0,
"totalNetPrice": 0,
"totalPromotionSavings": 0,
"totalSalePrice": 0,
"unitListPrice": 0,
"unitNetPrice": 0,
"unitTotalContractValue": 0
},
"uom": "string"
}
],
"usageSubmissionModel": "string"
}
Property Of
DistributorSubscriptionDetails
ResellerSubscriptionDetails
