V3SubscriptionOfferGroup

V3SubscriptionOfferGroup
V3SubscriptionOfferGroup

Offer groups in the subscription with current statuses

JSON Example
{
    "billingFrequency": "PREPAID",
    "billingModel": "string",
    "billingTerm": 1,
    "billingTermUom": "MONTHS",
    "chargeId": "VOD-DBC-01",
    "configErrors": [
        {
            "allowedValues": [
                "string"
            ],
            "errorCode": "string",
            "fieldName": "licenseUnit",
            "message": "Blah failed. Orphaned Addon needs to be adjusted",
            "referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
            "ruleId": "rule123"
        }
    ],
    "customerSegment": "COMMERCIAL",
    "description": "vSphere vRCU with Advanced AI-driven cloud storage",
    "hideOffers": false,
    "name": "vSphere-vRCU",
    "offerCategory": "PRIMARY",
    "offerConfigGroups": [
        {
            "allocatedQuantity": 5,
            "offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
            "offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
        }
    ],
    "offerGroupCost": {
        "creditSavings": [
            {
                "creditAmount": -1.5,
                "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                "type": "string"
            }
        ],
        "discountSavings": [
            {
                "attributes": {
                    "attributes": "string"
                },
                "discountAmount": -1.5,
                "type": "RCD"
            }
        ],
        "promotionSavings": [
            {
                "promotionAmount": -58.63,
                "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                "promotionName": "Promo description",
                "promotionPercent": 0.1,
                "promotionServiceDetails": [
                    {
                        "description": "VMware Cloud DR",
                        "productFamily": "VMC-AWS",
                        "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                    }
                ],
                "promotionType": "PERCENTAGE (or) AMOUNT",
                "remainingAmount": -28.63,
                "sellerPromotionInstanceId": "20"
            }
        ],
        "prorationFactor": 0.6,
        "remainingContractValue": 421.68,
        "surrenderValue": 421.68,
        "totalContractValue": 421.68,
        "totalCreditSavings": -1.63,
        "totalDiscountSavings": -10,
        "totalListContractValue": 41.68,
        "totalListPrice": 586.32,
        "totalNetAmount": 421.68,
        "totalPromotionSavings": -158.63,
        "totalSalePrice": 576.32,
        "totalTaxes": 5.62,
        "transitionPeriodCost": 121.38,
        "transitionalPrices": {
            "anet": 1.5,
            "cnet": 2.5,
            "enet": 3.5
        },
        "unitListContractValue": 1.68,
        "unitListPrice": 12.32,
        "unitNetAmount": 21.68,
        "unitTotalContractValue": 31.68,
        "unitTotalListContractValue": 89.49
    },
    "offerGroupCreationDateTime": "2020-04-07T00:05:01.194Z",
    "offerGroupEndDateTime": "2020-04-07T00:05:01.194Z",
    "offerGroupId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
    "offerGroupStartDateTime": "2020-04-07T00:05:01.194Z",
    "offerLabels": {
        "offerLabels": "string"
    },
    "offerSubCategory": "CONFIG_BUNDLE",
    "offerType": "COMMIT",
    "offers": [
        {
            "additionalAttributes": {},
            "billingFrequency": "PREPAID",
            "billingModel": "string",
            "billingTerm": 1,
            "billingTermUom": "MONTHS",
            "chargeId": "VOD-DBC-01",
            "chargeType": "STANDARD",
            "components": [
                {
                    "description": "A long Service Standard Offer description",
                    "productFamily": "VMC-AWS",
                    "productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
                    "quantity": 5
                }
            ],
            "configErrors": [
                {
                    "allowedValues": [
                        "string"
                    ],
                    "errorCode": "string",
                    "fieldName": "licenseUnit",
                    "message": "Blah failed. Orphaned Addon needs to be adjusted",
                    "referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
                    "ruleId": "rule123"
                }
            ],
            "customerSegment": "COMMERCIAL",
            "dataCenter": "US-WEST1",
            "deprovisioning": "string",
            "description": "A non localized description of offer",
            "exchangeOffers": [
                {
                    "deprovisioning": "string",
                    "flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
                    "purchaseQuantity": 10,
                    "referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
                    "status": "string",
                    "type": "string"
                }
            ],
            "flexExchangeDateTime": "2021-03-02T00:05:01.194Z",
            "hostingType": "SHARED",
            "isMandatoryInOfferGroup": false,
            "licenseUnit": "DEVICE",
            "name": "VMware Cloud on AWS",
            "offerCategory": "string",
            "offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
            "offerConfigGroups": [
                {
                    "allocatedQuantity": 5,
                    "offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
                    "offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
                }
            ],
            "offerCost": {
                "creditSavings": [
                    {
                        "creditAmount": -1.5,
                        "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                        "type": "string"
                    }
                ],
                "discountSavings": [
                    {
                        "attributes": {
                            "attributes": "string"
                        },
                        "discountAmount": -1.5,
                        "type": "RCD"
                    }
                ],
                "promotionSavings": [
                    {
                        "promotionAmount": -58.63,
                        "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                        "promotionName": "Promo description",
                        "promotionPercent": 0.1,
                        "promotionServiceDetails": [
                            {
                                "description": "VMware Cloud DR",
                                "productFamily": "VMC-AWS",
                                "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                            }
                        ],
                        "promotionType": "PERCENTAGE (or) AMOUNT",
                        "remainingAmount": -28.63,
                        "sellerPromotionInstanceId": "20"
                    }
                ],
                "prorationFactor": 0.6,
                "remainingContractValue": 421.68,
                "surrenderValue": 421.68,
                "totalContractValue": 421.68,
                "totalCreditSavings": -1.63,
                "totalDiscountSavings": -10,
                "totalListContractValue": 41.68,
                "totalListPrice": 586.32,
                "totalNetAmount": 421.68,
                "totalPromotionSavings": -158.63,
                "totalSalePrice": 576.32,
                "totalTaxes": 5.62,
                "transitionPeriodCost": 121.38,
                "transitionalPrices": {
                    "anet": 1.5,
                    "cnet": 2.5,
                    "enet": 3.5
                },
                "unitListContractValue": 1.68,
                "unitListPrice": 12.32,
                "unitNetAmount": 21.68,
                "unitTotalContractValue": 31.68,
                "unitTotalListContractValue": 89.49
            },
            "offerEndDateTime": "2020-04-07T00:05:01.194Z",
            "offerGroupMultiplier": 5,
            "offerLabels": {
                "offerLabels": "string"
            },
            "offerStartDateTime": "2020-04-07T00:05:01.194Z",
            "offerSubCategory": "string",
            "offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
            "offerType": "COMMIT",
            "operatingSystem": "Linux",
            "productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
            "programOption": "VA21",
            "proratedOfferCost": {
                "creditSavings": [
                    {
                        "creditAmount": -1.5,
                        "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                        "type": "string"
                    }
                ],
                "discountSavings": [
                    {
                        "attributes": {
                            "attributes": "string"
                        },
                        "discountAmount": -1.5,
                        "type": "RCD"
                    }
                ],
                "promotionSavings": [
                    {
                        "promotionAmount": -58.63,
                        "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                        "promotionName": "Promo description",
                        "promotionPercent": 0.1,
                        "promotionServiceDetails": [
                            {
                                "description": "VMware Cloud DR",
                                "productFamily": "VMC-AWS",
                                "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                            }
                        ],
                        "promotionType": "PERCENTAGE (or) AMOUNT",
                        "remainingAmount": -28.63,
                        "sellerPromotionInstanceId": "20"
                    }
                ],
                "prorationFactor": 0.6,
                "remainingContractValue": 421.68,
                "surrenderValue": 421.68,
                "totalContractValue": 421.68,
                "totalCreditSavings": -1.63,
                "totalDiscountSavings": -10,
                "totalListContractValue": 41.68,
                "totalListPrice": 586.32,
                "totalNetAmount": 421.68,
                "totalPromotionSavings": -158.63,
                "totalSalePrice": 576.32,
                "totalTaxes": 5.62,
                "transitionPeriodCost": 121.38,
                "transitionalPrices": {
                    "anet": 1.5,
                    "cnet": 2.5,
                    "enet": 3.5
                },
                "unitListContractValue": 1.68,
                "unitListPrice": 12.32,
                "unitNetAmount": 21.68,
                "unitTotalContractValue": 31.68,
                "unitTotalListContractValue": 89.49
            },
            "purchaseQuantity": 10,
            "referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
            "region": "EMEA",
            "retentionPeriod": "P2M",
            "routeToMarket": "string",
            "serviceDefinedAttributes": [
                {
                    "name": "string",
                    "value": "string"
                }
            ],
            "serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
            "status": "string",
            "statusChangeDateTime": "2020-04-07T00:05:01.194Z",
            "supportLevel": "Basic",
            "tierDescription": "string",
            "tierName": "T1",
            "uom": "HOST",
            "uomTimeScale": "HOUR",
            "usageItems": [
                {
                    "additionalAttributes": {},
                    "billingFrequency": "PREPAID",
                    "billingModel": "string",
                    "billingTerm": 1,
                    "billingTermUom": "MONTHS",
                    "chargeId": "VOD-DBC-01",
                    "chargeType": "STANDARD",
                    "components": [
                        {
                            "description": "A long Service Standard Offer description",
                            "productFamily": "VMC-AWS",
                            "productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
                            "quantity": 5
                        }
                    ],
                    "configErrors": [
                        {
                            "allowedValues": [
                                "string"
                            ],
                            "errorCode": "string",
                            "fieldName": "licenseUnit",
                            "message": "Blah failed. Orphaned Addon needs to be adjusted",
                            "referenceId": "cb2425b4-203b-4a2a-8a72-2555aa7d4ec6",
                            "ruleId": "rule123"
                        }
                    ],
                    "customerSegment": "COMMERCIAL",
                    "dataCenter": "US-WEST1",
                    "description": "A non localized description of offer",
                    "hostingType": "SHARED",
                    "isMandatoryInOfferGroup": false,
                    "licenseUnit": "DEVICE",
                    "name": "VMware Cloud on AWS",
                    "offerCategory": "string",
                    "offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
                    "offerConfigGroups": [
                        {
                            "allocatedQuantity": 5,
                            "offerConfigGroupId": "fb660ba4-08d1-49ac-a497-c19cb3c098a9",
                            "offerRuleValidationReferenceId": "eb660ba4-08d1-49ac-a497-c19cb3c098a9"
                        }
                    ],
                    "offerCost": {
                        "creditSavings": [
                            {
                                "creditAmount": -1.5,
                                "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                                "type": "string"
                            }
                        ],
                        "discountSavings": [
                            {
                                "attributes": {
                                    "attributes": "string"
                                },
                                "discountAmount": -1.5,
                                "type": "RCD"
                            }
                        ],
                        "promotionSavings": [
                            {
                                "promotionAmount": -58.63,
                                "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                                "promotionName": "Promo description",
                                "promotionPercent": 0.1,
                                "promotionServiceDetails": [
                                    {
                                        "description": "VMware Cloud DR",
                                        "productFamily": "VMC-AWS",
                                        "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                                    }
                                ],
                                "promotionType": "PERCENTAGE (or) AMOUNT",
                                "remainingAmount": -28.63,
                                "sellerPromotionInstanceId": "20"
                            }
                        ],
                        "prorationFactor": 0.6,
                        "remainingContractValue": 421.68,
                        "surrenderValue": 421.68,
                        "totalContractValue": 421.68,
                        "totalCreditSavings": -1.63,
                        "totalDiscountSavings": -10,
                        "totalListContractValue": 41.68,
                        "totalListPrice": 586.32,
                        "totalNetAmount": 421.68,
                        "totalPromotionSavings": -158.63,
                        "totalSalePrice": 576.32,
                        "totalTaxes": 5.62,
                        "transitionPeriodCost": 121.38,
                        "transitionalPrices": {
                            "anet": 1.5,
                            "cnet": 2.5,
                            "enet": 3.5
                        },
                        "unitListContractValue": 1.68,
                        "unitListPrice": 12.32,
                        "unitNetAmount": 21.68,
                        "unitTotalContractValue": 31.68,
                        "unitTotalListContractValue": 89.49
                    },
                    "offerGroupMultiplier": 5,
                    "offerLabels": {
                        "offerLabels": "string"
                    },
                    "offerSubCategory": "string",
                    "offerTimelineGroupId": "704b3943-93bb-4f5e-a3eb-396253cf1808",
                    "offerType": "COMMIT",
                    "operatingSystem": "Linux",
                    "productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
                    "programOption": "VA21",
                    "proratedOfferCost": {
                        "creditSavings": [
                            {
                                "creditAmount": -1.5,
                                "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                                "type": "string"
                            }
                        ],
                        "discountSavings": [
                            {
                                "attributes": {
                                    "attributes": "string"
                                },
                                "discountAmount": -1.5,
                                "type": "RCD"
                            }
                        ],
                        "promotionSavings": [
                            {
                                "promotionAmount": -58.63,
                                "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                                "promotionName": "Promo description",
                                "promotionPercent": 0.1,
                                "promotionServiceDetails": [
                                    {
                                        "description": "VMware Cloud DR",
                                        "productFamily": "VMC-AWS",
                                        "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                                    }
                                ],
                                "promotionType": "PERCENTAGE (or) AMOUNT",
                                "remainingAmount": -28.63,
                                "sellerPromotionInstanceId": "20"
                            }
                        ],
                        "prorationFactor": 0.6,
                        "remainingContractValue": 421.68,
                        "surrenderValue": 421.68,
                        "totalContractValue": 421.68,
                        "totalCreditSavings": -1.63,
                        "totalDiscountSavings": -10,
                        "totalListContractValue": 41.68,
                        "totalListPrice": 586.32,
                        "totalNetAmount": 421.68,
                        "totalPromotionSavings": -158.63,
                        "totalSalePrice": 576.32,
                        "totalTaxes": 5.62,
                        "transitionPeriodCost": 121.38,
                        "transitionalPrices": {
                            "anet": 1.5,
                            "cnet": 2.5,
                            "enet": 3.5
                        },
                        "unitListContractValue": 1.68,
                        "unitListPrice": 12.32,
                        "unitNetAmount": 21.68,
                        "unitTotalContractValue": 31.68,
                        "unitTotalListContractValue": 89.49
                    },
                    "purchaseQuantity": 10,
                    "referenceId": "b76e573a-8df7-4375-a0ca-d1e80412c3b6",
                    "region": "EMEA",
                    "retentionPeriod": "P2M",
                    "routeToMarket": "string",
                    "serviceDefinedAttributes": [
                        {
                            "name": "string",
                            "value": "string"
                        }
                    ],
                    "serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
                    "supportLevel": "Basic",
                    "tierDescription": "string",
                    "tierName": "T1",
                    "uom": "HOST",
                    "uomTimeScale": "HOUR",
                    "usageSubmissionModel": "string"
                }
            ],
            "usageSubmissionModel": "string"
        }
    ],
    "productId": "00304f3b-e66e-4e23-8d81-7a13417073d1",
    "programOption": "VA21",
    "proratedOfferGroupCost": {
        "creditSavings": [
            {
                "creditAmount": -1.5,
                "creditReference": "a3cd0d29-7580-4bed-831f-a0976a7de7e3",
                "type": "string"
            }
        ],
        "discountSavings": [
            {
                "attributes": {
                    "attributes": "string"
                },
                "discountAmount": -1.5,
                "type": "RCD"
            }
        ],
        "promotionSavings": [
            {
                "promotionAmount": -58.63,
                "promotionCode": "VMC_AWS_10_PERCENT_OFF",
                "promotionName": "Promo description",
                "promotionPercent": 0.1,
                "promotionServiceDetails": [
                    {
                        "description": "VMware Cloud DR",
                        "productFamily": "VMC-AWS",
                        "serviceDefinitionId": "b3cd0d29-7580-4bed-831f-a0976a7de7e6"
                    }
                ],
                "promotionType": "PERCENTAGE (or) AMOUNT",
                "remainingAmount": -28.63,
                "sellerPromotionInstanceId": "20"
            }
        ],
        "prorationFactor": 0.6,
        "remainingContractValue": 421.68,
        "surrenderValue": 421.68,
        "totalContractValue": 421.68,
        "totalCreditSavings": -1.63,
        "totalDiscountSavings": -10,
        "totalListContractValue": 41.68,
        "totalListPrice": 586.32,
        "totalNetAmount": 421.68,
        "totalPromotionSavings": -158.63,
        "totalSalePrice": 576.32,
        "totalTaxes": 5.62,
        "transitionPeriodCost": 121.38,
        "transitionalPrices": {
            "anet": 1.5,
            "cnet": 2.5,
            "enet": 3.5
        },
        "unitListContractValue": 1.68,
        "unitListPrice": 12.32,
        "unitNetAmount": 21.68,
        "unitTotalContractValue": 31.68,
        "unitTotalListContractValue": 89.49
    },
    "purchaseQuantity": 10,
    "routeToMarket": "string",
    "serviceDefinedAttributes": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "serviceDefinitionId": "8a27ac37-66f1-4a03-be36-dbe55b05f96c",
    "status": "ACTIVE",
    "supportLevel": "Basic",
    "uom": "HOST"
}
string
billingFrequency
Required

The frequency at which billing is made.

Possible values are : PREPAID, MONTHLY, ANNUAL,
billingModel
Optional

The billing model of the service definition id on the offer group

Possible values are : COMMIT_REQUIRED, COMMIT_OPTIONAL, COMMIT_ONLY,
integer As int32 As int32
billingTerm
Optional

Applicable only for COMMIT

string
billingTermUom
Optional

Applicable only for COMMIT

string
chargeId
Optional

Charge ID associated with the lead service definition for the offer groups

configErrors
Optional

CPQ configuration errors response at this level. See https://confluence.eng.vmware.com/x/IS79Og

string
customerSegment
Optional

Customer segment

Possible values are : ACADEMIC, COMMERCIAL, GOVERNMENT,
string
description
Required

The description of the offer-group.

boolean
hideOffers
Optional

If set to true, all underlying offers will be hidden

string
name
Required

Offer group name represents the name of the bundle.

string
offerCategory
Required

The offer group category

Possible values are : PRIMARY, ADDON, ONETIME, ONDEMAND,
offerConfigGroups
Optional

This is populated in GET subscriptions and PREVIEW subscription transaction responses only. Offer config groupings are formed from the configuration of the offer-groups(offers, attributes, etc.) in the billing engine. It is used to identify tier switch, qty expansions during upgrades.

offerGroupCost
Required

Offer cost, for more info see: https://confluence.eng.vmware.com/x/PUJNNQ

string
offerGroupCreationDateTime
Required

When offer group was created

string
offerGroupEndDateTime
Optional

Offer group end date time

string
offerGroupId
Required

Offer group Id. An unique Id per instance of offer-group purchase.

string
offerGroupStartDateTime
Optional

Offer group start date time

object
offerLabels
Optional

Offer labels of the bundle. Offer labels are key-value pairs used to tag a group of offers with a label.

string
offerSubCategory
Required

Offer group sub-category

Possible values are : FLEX, BUNDLE, PH_HOSTING, PH_SNS_FOR_BASE, PH_SNS_FOR_ADDON, PS_REGULAR, PS_CONFIGURABLE, PH_BASE_SW, PH_ADDON_SW, OVERAGE, REGISTRATION, CONFIG_BUNDLE, TEMPLATE_BUNDLE,
string
offerType
Required

Offer Type represents offer is COMMIT/ONDEMAND.

Possible values are : ONDEMAND, COMMIT,
offers
Required

Offers of offer-group in the subscription with current statuses

string
productId
Required

Globally unique product id of the offer-group shell SKU

string
programOption
Optional

Program eligibility

proratedOfferGroupCost
Optional

Offer cost, for more info see: https://confluence.eng.vmware.com/x/PUJNNQ

integer As int32 As int32
purchaseQuantity
Required
Constraints: minimum: 0

Quantity purchased. Applicable only for COMMIT

string
routeToMarket
Optional

Route to market strategy.

Possible values are : DIRECT, RESELLER, DISTRIBUTOR, MSP,
serviceDefinedAttributes
Optional

Service specific attributes. Those are treated as any other offer attribute(such as billingTerm, region, etc) and allow for services to define custom attributes applicable only for their offers. This is not the same as the metadata field, which is for arbitrary data. Billing engine specific attributes such as externalSKU, shellId are also defined here.

string
serviceDefinitionId
Optional

The lead service definition tied to this offer group. Required for Cloud Packs

string
status
Optional

Offer group status.

Possible values are : SUBMITTED, PENDING_PROVISIONING, ERROR, ACTIVE, PENDING_CANCEL, CANCELLED, TERMINATED, PENDING_ACTIVE, EXPIRED,
string
supportLevel
Optional

Level of support available, e.g. Production, Basic

string
uom
Optional

Applicable for commit offer only. Each service may have its own UOM. Some services may use Host and others may use CPUs...etc