ProformaOffer
Offers active under the Proforma Customer
Properties
A Map<String, String> that holds extra information about the offer
End Date for the billing of Proforma Offer
Order Id for Proforma Offer placed via the Billing Engine
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
Start Date for the billing of Proforma Offer
CBC ID for the Proforma Offer
Currency used to purchase the offer
Offer description from billing engine
End date time of the offer
Extended Discount for the Proforma Offer
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
PO Number for the Proforma Offer
PR Number for the Proforma Offer
Program eligibility such as Subscription Upgrade
Quantity for purchase. Applicable only for COMMIT
Purchase quantity Unit Of Measurement
Reference ID of the offer
Renewal date for Proforma Offers
End Date for the service activated under the Proforma Offer
Start Date for the service activated under the Proforma Offer
SKU of the offer based on the offer attributes
Cross Reference Sku for Proforma Offers
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
Tier name. Tier attributes will be populated in case of tier volume pricing. Applicable only when chargeType is TIERED
Total List Price for the Proforma Offer
Total List Price for the Proforma Offer
Type of transaction for the Proforma Offer
Unit List Price for the Proforma Offer
Unit Net Price for the Proforma Offer
Unit of Measurement for the service activated under the Proforma Offer
The usage submission variants applicable for models that support usage
JSON Example
{
"additionalAttributes": {
"key": "string"
},
"billingEndDate": "string",
"billingEngineOrderId": "string",
"billingFrequency": "PREPAID",
"billingModel": "COMMIT_REQUIRED",
"billingStartDate": "string",
"cbcId": "string",
"currency": "string",
"description": "string",
"discountsavings": [
{
"attributes": {},
"discountAmount": 0,
"number": "string",
"type": "RCD"
}
],
"endDate": "string",
"extendedDiscount": "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",
"poNumber": "string",
"prNumber": "string",
"programOption": "string",
"purchaseQuantity": 0,
"quantityUom": "string",
"referenceId": "string",
"renewalDate": "string",
"serviceEndDate": "string",
"serviceRef": {
"id": "string",
"name": "string",
"serviceIcon": "string"
},
"serviceStartDate": "string",
"sku": "string",
"skuDescription": "string",
"startDate": "string",
"status": "SUBMITTED",
"tierName": "string",
"totalListPrice": 0,
"totalNetPrice": 0,
"transactionType": "string",
"unitListPrice": 0,
"unitNetPrice": 0,
"unitOfMeasure": "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"
}
