[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

ProformaOffer

Offers active under the Proforma Customer


Properties

map of string
additionalAttributes Optional

A Map<String, String> that holds extra information about the offer


string
billingEndDate Optional

End Date for the billing of Proforma Offer


string
billingEngineOrderId Optional

Order Id for Proforma Offer placed via the Billing Engine


string
billingFrequency Optional

Billing frequency of the offer

Possible values are: PREPAIDMONTHLYANNUAL


string
billingModel Optional

The offer billing model based on supported models

Possible values are: COMMIT_REQUIREDCOMMIT_OPTIONALCOMMIT_ONLY


string
billingStartDate Optional

Start Date for the billing of Proforma Offer


string
cbcId Optional

CBC ID for the Proforma Offer


string
crossRefSku Optional

SKU of the offer based on the offer attributes


string
crossRefSkuDescription Optional

Cross Reference Sku for Proforma Offers


string
currency Optional

Currency used to purchase the offer


string
description Optional

Offer description from billing engine


discountsavings Optional

Discount Savings for the Proforma Offer


string
endDate Optional

End date time of the offer


string
extendedDiscount Optional

Extended Discount for the Proforma Offer


string
licenseUnit Optional

License Unit of the offer


string
name Optional

Given name of the offer


string
offerCategory Optional

Category of the offer such as Primary, Addon or Onetime

Possible values are: PRIMARYADDONONETIME


offerCost Optional

Cost object for a subscription


string
offerType Optional

Type of Offer such as On-Demand or Commit

Possible values are: ONDEMANDCOMMIT


string
poNumber Optional

PO Number for the Proforma Offer


string
prNumber Optional

PR Number for the Proforma Offer


string
programOption Optional

Program eligibility such as Subscription Upgrade


integer as int32
purchaseQuantity Optional

Quantity for purchase. Applicable only for COMMIT


string
quantityUom Optional

Purchase quantity Unit Of Measurement


string
referenceId Optional

Reference ID of the offer


string
renewalDate Optional

Renewal date for Proforma Offers


string
serviceEndDate Optional

End Date for the service activated under the Proforma Offer


serviceRef Optional

Reference object containing minimal details of a service


string
serviceStartDate Optional

Start Date for the service activated under the Proforma Offer


string
startDate Optional

Start date time of the offer


string
status Optional

Lifecycle status of the offer

Possible values are: SUBMITTEDPENDING_PROVISIONINGERRORACTIVEPENDING_CANCELCANCELLEDTERMINATEDPENDING_ACTIVEEXPIRED


string
tierName Optional

Tier name. Tier attributes will be populated in case of tier volume pricing. Applicable only when chargeType is TIERED


number as double
totalListPrice Optional

Total List Price for the Proforma Offer


number as double
totalNetPrice Optional

Total List Price for the Proforma Offer


string
transactionType Optional

Type of transaction for the Proforma Offer


number as double
unitListPrice Optional

Unit List Price for the Proforma Offer


number as double
unitNetPrice Optional

Unit Net Price for the Proforma Offer


string
unitOfMeasure Optional

Unit of Measurement for the service activated under the Proforma Offer


array of UsageItem
usageItems Optional

List of usage items for the offer


string
usageSubmissionModel Optional

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",
	"crossRefSku": "string",
	"crossRefSkuDescription": "string",
	"currency": "string",
	"description": "string",
	"discountsavings": [
		{
			"attributes": {},
			"discountAmount": 0,
			"number": "string",
			"type": "RCD"
		}
	],
	"endDate": "string",
	"extendedDiscount": "string",
	"licenseUnit": "string",
	"name": "string",
	"offerCategory": "PRIMARY",
	"offerCost": {
		"cNetPrice": 0,
		"creditSavings": [
			{
				"creditAmount": 0,
				"creditReference": "string",
				"type": "FLEX_EXCHANGE"
			}
		],
		"discountSavings": [
			{
				"attributes": {
					"key": "string"
				},
				"discountAmount": 0,
				"type": "RCD"
			}
		],
		"snsCredit": 0,
		"totalCreditSavings": 0,
		"totalDiscountSavings": 0,
		"totalListPrice": 0,
		"totalNetPrice": 0,
		"unitListPrice": 0,
		"unitNetPrice": 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",
	"startDate": "string",
	"status": "SUBMITTED",
	"tierName": "string",
	"totalListPrice": 0,
	"totalNetPrice": 0,
	"transactionType": "string",
	"unitListPrice": 0,
	"unitNetPrice": 0,
	"unitOfMeasure": "string",
	"usageItems": [
		{
			"chargeId": "string",
			"chargeType": "string",
			"crossRefSku": "string",
			"currency": "string",
			"description": "string",
			"name": "string",
			"offerCost": {
				"cNetPrice": 0,
				"creditSavings": [
					{
						"creditAmount": 0,
						"creditReference": "string",
						"type": "FLEX_EXCHANGE"
					}
				],
				"discountSavings": [
					{
						"attributes": {
							"key": "string"
						},
						"discountAmount": 0,
						"type": "RCD"
					}
				],
				"snsCredit": 0,
				"totalCreditSavings": 0,
				"totalDiscountSavings": 0,
				"totalListPrice": 0,
				"totalNetPrice": 0,
				"unitListPrice": 0,
				"unitNetPrice": 0
			},
			"productId": "string",
			"purchaseQuantity": 0,
			"tierName": "string",
			"uom": "string"
		}
	],
	"usageSubmissionModel": "string"
}
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Property Of

ProformaHeaders

Feedback

Was this page helpful?