Below is an example of the full zuora model with additional parameters from Zuora's product, ratePlan, and promotionCode objects shown (see Zuora's own documentation for more information about each if these parameters and go here if you are looking for our full Zuora integration guide). The first item below is a "product" with multiple rate plans that have different pricing options for the US and EU. The second item is a promo code with a 20 percent discount:
{
"zuora": {
"selectedItems": [{
"type": "product",
"product": {
"id": "2c92c0...",
"sku": "SKU-00000005",
"name": "Digital access",
"description": "",
"category": null,
"effectiveStartDate": "2017-01-17",
"effectiveEndDate": "2017-03-06",
"productRatePlans": [{
"id": "2c92c0...",
"status": "Expired",
"name": "First Rate Plan",
"description": "",
"effectiveStartDate": "2017-01-18",
"effectiveEndDate": "2017-01-20",
"test_date_fields__c": "2017-02-17",
"test_pick_list__c": "value1",
"test_text_field__c": "defaultValue_s",
"productRatePlanCharges": [{
"id": "2c92c0...",
"name": "New Component",
"type": "OneTime",
"model": "FlatFee",
"uom": null,
"pricingSummary": [
"USD55",
"EUR10"
],
"pricing": [{
"currency": "USD",
"price": 55,
"tiers": null,
"includedUnits": null,
"overagePrice": null,
"discountPercentage": null,
"discountAmount": null
},
{
"currency": "EUR",
"price": 10,
"tiers": null,
"includedUnits": null,
"overagePrice": null,
"discountPercentage": null,
"discountAmount": null
}
],
"defaultQuantity": null,
"applyDiscountTo": null,
"discountLevel": null,
"discountClass": null,
"productDiscountApplyDetails": [],
"endDateCondition": "One_Time",
"upToPeriods": null,
"upToPeriodsType": null,
"billingDay": null,
"listPriceBase": null,
"billingTiming": null,
"billingPeriod": null,
"billingPeriodAlignment": null,
"specificBillingPeriod": null,
"smoothingModel": null,
"numberOfPeriods": null,
"overageCalculationOption": null,
"overageUnusedUnitsCreditOption": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"priceChangeOption": null,
"priceIncreasePercentage": null,
"useTenantDefaultForPriceChange": null,
"taxable": false,
"taxCode": "",
"taxMode": null,
"triggerEvent": "ServiceActivation",
"description": "",
"revenueRecognitionRuleName": "Recognize upon invoicing",
"useDiscountSpecificAccountingCode": null,
"financeInformation": {
"recognizedRevenueAccountingCode": "Customer Cash on Account",
"recognizedRevenueAccountingCodeType": "CustomerCashOnAccount",
"deferredRevenueAccountingCode": "Customer Cash on Account",
"deferredRevenueAccountingCodeType": "CustomerCashOnAccount"
}
}]
},
{
"id": "2c92c0...",
"status": "Expired",
"name": "Second Rate Plan",
"description": "",
"effectiveStartDate": "2017-01-18",
"effectiveEndDate": "2017-01-20",
"test_date_fields__c": "2017-02-16",
"test_pick_list__c": "value1",
"test_text_field__c": "defaultValue_s",
"productRatePlanCharges": [{
"id": "2c92c0...",
"name": "New Component Two",
"type": "OneTime",
"model": "FlatFee",
"uom": null,
"pricingSummary": [
"USD44",
"EUR20"
],
"pricing": [{
"currency": "USD",
"price": 44,
"tiers": null,
"includedUnits": null,
"overagePrice": null,
"discountPercentage": null,
"discountAmount": null
},
{
"currency": "EUR",
"price": 20,
"tiers": null,
"includedUnits": null,
"overagePrice": null,
"discountPercentage": null,
"discountAmount": null
}
],
"defaultQuantity": null,
"applyDiscountTo": null,
"discountLevel": null,
"discountClass": null,
"productDiscountApplyDetails": [],
"endDateCondition": "One_Time",
"upToPeriods": null,
"upToPeriodsType": null,
"billingDay": null,
"listPriceBase": null,
"billingTiming": null,
"billingPeriod": null,
"billingPeriodAlignment": null,
"specificBillingPeriod": null,
"smoothingModel": null,
"numberOfPeriods": null,
"overageCalculationOption": null,
"overageUnusedUnitsCreditOption": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"priceChangeOption": null,
"priceIncreasePercentage": null,
"useTenantDefaultForPriceChange": null,
"taxable": false,
"taxCode": "",
"taxMode": null,
"triggerEvent": "ServiceActivation",
"description": "",
"revenueRecognitionRuleName": "Recognize upon invoicing",
"useDiscountSpecificAccountingCode": null,
"financeInformation": {
"recognizedRevenueAccountingCode": "Customer Cash on Account",
"recognizedRevenueAccountingCodeType": "CustomerCashOnAccount",
"deferredRevenueAccountingCode": "Customer Cash on Account",
"deferredRevenueAccountingCodeType": "CustomerCashOnAccount"
}
}]
}
},
{
"type": "promotionCode",
"promotionCode": {
"id": 2075443,
"code": "TEST_CODE",
"campaign": "TEST",
"createdAt": "2017-02-28T02:18:45.266-07:00",
"updatedAt": "2017-02-28T02:20:00.718-07:00",
"availableQuantity": 9999,
"effectiveFrom": "2017-02-27T02:00:00.000-07:00",
"effectiveTo": "2999-03-01T02:00:00.000-07:00",
"initialQuantity": 9999,
"discount": {
"type": "percent",
"ratePlan": {
"id": "2c92c0...",
"name": "Quant Ratings - Discount Plan - Percent - 20%",
"status": "Active",
"OfferID__c": null,
"description": "Quant Ratings - Discount Plan - Percent - 20%",
"OfferCode__c": null,
"FreeTrialDays__c": "0",
"effectiveEndDate": "2999-01-01",
"effectiveStartDate": "2000-01-01",
"productRatePlanCharges": [{
"id": "2c92c0...",
"uom": null,
"name": "Quant Ratings - Discount Plan - Percent - 20%",
"type": "Recurring",
"model": "DiscountPercentage",
"pricing": [{
"price": null,
"tiers": null,
"currency": "USD",
"overagePrice": null,
"includedUnits": null,
"discountAmount": null,
"discountPercentage": 20
}],
"taxCode": null,
"taxMode": null,
"taxable": false,
"billingDay": "SubscriptionStartDay",
"description": "Quant Ratings - Discount Plan - Percent - 20%",
"upToPeriods": null,
"triggerEvent": "ContractEffective",
"FloorPrice__c": "$0.00",
"billingPeriod": "Month",
"billingTiming": null,
"discountClass": null,
"discountLevel": "subscription",
"listPriceBase": null,
"IsFreeTrial__c": "false",
"pricingSummary": [
"20% discount"
],
"smoothingModel": null,
"CeilingPrice__c": "$0.00",
"applyDiscountTo": "ONETIMERECURRINGUSAGE",
"defaultQuantity": null,
"numberOfPeriods": null,
"upToPeriodsType": null,
"endDateCondition": "Subscription_End",
"priceChangeOption": "NoChange",
"financeInformation": {
"deferredRevenueAccountingCode": null,
"recognizedRevenueAccountingCode": null,
"deferredRevenueAccountingCodeType": null,
"recognizedRevenueAccountingCodeType": null
},
"RenewalPriceLevel1__c": "$0.00",
"RenewalPriceLevel2__c": "$0.00",
"RenewalPriceLevel3__c": "$0.00",
"RenewalPriceLevel4__c": "$0.00",
"RenewalPriceLevel5__c": "$0.00",
"specificBillingPeriod": null,
"billingPeriodAlignment": "AlignToCharge",
"priceIncreasePercentage": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"overageCalculationOption": null,
"revenueRecognitionRuleName": null,
"productDiscountApplyDetails": [],
"overageUnusedUnitsCreditOption": null,
"useTenantDefaultForPriceChange": false,
"useDiscountSpecificAccountingCode": false
}]
}
},
"customFields": {
"ORIGIN_ID": {
"type": "string",
"value": "",
"required": false,
"validateRequirement": false
},
"OFFER_CODE": {
"type": "string",
"value": "",
"required": false,
"validateRequirement": false
},
"PRODUCT_CODE": {
"type": "string",
"value": "",
"required": false,
"validateRequirement": false
},
"PROMOTION_CODE": {
"type": "string",
"value": "",
"required": false,
"validateRequirement": false
}
},
"ratePlanGroups": [
[{
"id": "2c92c0f8591b67df01591d2a6d871b12",
"name": " Quant Ratings - 1 Quarter Plan - $49.95",
"status": "Active",
"OfferID__c": null,
"description": "",
"OfferCode__c": null,
"FreeTrialDays__c": "0",
"effectiveEndDate": "2999-12-31",
"effectiveStartDate": "2016-12-20",
"productRatePlanCharges": [{
"id": "2c92c0f9591b6ea701591d3e0b3523c5",
"uom": null,
"name": "Quant Ratings - 1 Quarter Plan - $49.95",
"type": "Recurring",
"model": "FlatFee",
"pricing": [{
"price": 49.95,
"tiers": null,
"currency": "USD",
"overagePrice": null,
"includedUnits": null,
"discountAmount": null,
"discountPercentage": null
}],
"taxCode": "Sales Tax",
"taxMode": "TaxExclusive",
"taxable": true,
"billingDay": "SubscriptionStartDay",
"description": "Quant Ratings - 1 Quarter Plan - $49.95",
"upToPeriods": null,
"triggerEvent": "ServiceActivation",
"FloorPrice__c": "$49.95",
"billingPeriod": "Quarter",
"billingTiming": "IN_ADVANCE",
"discountClass": null,
"discountLevel": null,
"listPriceBase": "Per_Billing_Period",
"IsFreeTrial__c": "false",
"pricingSummary": [
"USD49.95"
],
"smoothingModel": null,
"CeilingPrice__c": "$49.95",
"applyDiscountTo": null,
"defaultQuantity": null,
"numberOfPeriods": null,
"upToPeriodsType": null,
"endDateCondition": "Subscription_End",
"priceChangeOption": "NoChange",
"financeInformation": {
"deferredRevenueAccountingCode": "Deferred Revenue - Quant Ratings",
"recognizedRevenueAccountingCode": "Revenue - Quant Ratings",
"deferredRevenueAccountingCodeType": "DeferredRevenue",
"recognizedRevenueAccountingCodeType": "SalesRevenue"
},
"RenewalPriceLevel1__c": "$49.95",
"RenewalPriceLevel2__c": "$49.95",
"RenewalPriceLevel3__c": "$49.95",
"RenewalPriceLevel4__c": "$49.95",
"RenewalPriceLevel5__c": "$49.95",
"specificBillingPeriod": null,
"billingPeriodAlignment": "AlignToCharge",
"priceIncreasePercentage": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"overageCalculationOption": null,
"revenueRecognitionRuleName": "Recognize daily over time",
"productDiscountApplyDetails": [],
"overageUnusedUnitsCreditOption": null,
"useTenantDefaultForPriceChange": false,
"useDiscountSpecificAccountingCode": null
}]
}],
[{
"id": "2c92c0...",
"name": "RealMoney - 01 Month - $19.99",
"status": "Active",
"OfferID__c": null,
"description": "RealMoney - 01 Month - $19.99",
"OfferCode__c": "OFRM-0167",
"FreeTrialDays__c": "0",
"effectiveEndDate": "2099-12-31",
"effectiveStartDate": "2000-01-01",
"productRatePlanCharges": [{
"id": "2c92c0...",
"uom": null,
"name": "RealMoney - Monthly Subscription",
"type": "Recurring",
"model": "FlatFee",
"pricing": [{
"price": 19.99,
"tiers": null,
"currency": "USD",
"overagePrice": null,
"includedUnits": null,
"discountAmount": null,
"discountPercentage": null
}],
"taxCode": "Sales Tax",
"taxMode": "TaxExclusive",
"taxable": true,
"billingDay": "SubscriptionStartDay",
"description": "RealMoney - Monthly Subscription",
"upToPeriods": null,
"triggerEvent": "ServiceActivation",
"FloorPrice__c": "$0.00",
"billingPeriod": "Month",
"billingTiming": "IN_ADVANCE",
"discountClass": null,
"discountLevel": null,
"listPriceBase": "Per_Billing_Period",
"IsFreeTrial__c": "false",
"pricingSummary": [
"USD19.99"
],
"smoothingModel": null,
"CeilingPrice__c": "$0.00",
"applyDiscountTo": null,
"defaultQuantity": null,
"numberOfPeriods": null,
"upToPeriodsType": null,
"endDateCondition": "Subscription_End",
"priceChangeOption": "NoChange",
"financeInformation": {
"deferredRevenueAccountingCode": "Deferred Revenue - Real Money",
"recognizedRevenueAccountingCode": "Revenue - Real Money",
"deferredRevenueAccountingCodeType": "DeferredRevenue",
"recognizedRevenueAccountingCodeType": "SalesRevenue"
},
"RenewalPriceLevel1__c": "$19.99",
"RenewalPriceLevel2__c": "$19.99",
"RenewalPriceLevel3__c": "$19.99",
"RenewalPriceLevel4__c": "$19.99",
"RenewalPriceLevel5__c": "$19.99",
"specificBillingPeriod": null,
"billingPeriodAlignment": "AlignToCharge",
"priceIncreasePercentage": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"overageCalculationOption": null,
"revenueRecognitionRuleName": "Recognize daily over time",
"productDiscountApplyDetails": [],
"overageUnusedUnitsCreditOption": null,
"useTenantDefaultForPriceChange": false,
"useDiscountSpecificAccountingCode": null
}]
}],
[{
"id": "2c92c0...",
"name": "Stocks Under 10 - 01 Month Plan - $29.95",
"status": "Active",
"OfferID__c": null,
"description": "Stocks Under 10 - 01 Month Plan - $29.95",
"OfferCode__c": "OFSU-0056",
"FreeTrialDays__c": "0",
"effectiveEndDate": "2999-12-31",
"effectiveStartDate": "2000-01-01",
"productRatePlanCharges": [{
"id": "2c92c0f9585841e701585dab51727ced",
"uom": null,
"name": "Stocks Under 10 - Monthly Subscription",
"type": "Recurring",
"model": "FlatFee",
"pricing": [{
"price": 29.95,
"tiers": null,
"currency": "USD",
"overagePrice": null,
"includedUnits": null,
"discountAmount": null,
"discountPercentage": null
}],
"taxCode": "Sales Tax",
"taxMode": "TaxExclusive",
"taxable": true,
"billingDay": "SubscriptionStartDay",
"description": "Stocks Under 10 - Monthly Subscription",
"upToPeriods": null,
"triggerEvent": "ServiceActivation",
"FloorPrice__c": "$0.00",
"billingPeriod": "Month",
"billingTiming": "IN_ADVANCE",
"discountClass": null,
"discountLevel": null,
"listPriceBase": "Per_Billing_Period",
"IsFreeTrial__c": "false",
"pricingSummary": [
"USD29.95"
],
"smoothingModel": null,
"CeilingPrice__c": "$0.00",
"applyDiscountTo": null,
"defaultQuantity": null,
"numberOfPeriods": null,
"upToPeriodsType": null,
"endDateCondition": "Subscription_End",
"priceChangeOption": "NoChange",
"financeInformation": {
"deferredRevenueAccountingCode": "Deferred Revenue - Stocks Under 10",
"recognizedRevenueAccountingCode": "Revenue - Stocks Under 10",
"deferredRevenueAccountingCodeType": "DeferredRevenue",
"recognizedRevenueAccountingCodeType": "SalesRevenue"
},
"RenewalPriceLevel1__c": "29.95",
"RenewalPriceLevel2__c": "29.95",
"RenewalPriceLevel3__c": "29.95",
"RenewalPriceLevel4__c": "29.95",
"RenewalPriceLevel5__c": "29.95",
"specificBillingPeriod": null,
"billingPeriodAlignment": "AlignToCharge",
"priceIncreasePercentage": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"overageCalculationOption": null,
"revenueRecognitionRuleName": "Recognize daily over time",
"productDiscountApplyDetails": [],
"overageUnusedUnitsCreditOption": null,
"useTenantDefaultForPriceChange": false,
"useDiscountSpecificAccountingCode": null
}]
}]
]
},
"ratePlan": {
"id": "2c92c0...",
"name": " Quant Ratings - 1 Quarter Plan - $49.95",
"status": "Active",
"OfferID__c": null,
"description": "",
"OfferCode__c": null,
"FreeTrialDays__c": "0",
"effectiveEndDate": "2999-12-31",
"effectiveStartDate": "2016-12-20",
"productRatePlanCharges": [{
"id": "2c92c0...",
"uom": null,
"name": "Quant Ratings - 1 Quarter Plan - $49.95",
"type": "Recurring",
"model": "FlatFee",
"pricing": [{
"price": 49.95,
"tiers": null,
"currency": "USD",
"overagePrice": null,
"includedUnits": null,
"discountAmount": null,
"discountPercentage": null
}],
"taxCode": "Sales Tax",
"taxMode": "TaxExclusive",
"taxable": true,
"billingDay": "SubscriptionStartDay",
"description": "Quant Ratings - 1 Quarter Plan - $49.95",
"upToPeriods": null,
"triggerEvent": "ServiceActivation",
"FloorPrice__c": "$49.95",
"billingPeriod": "Quarter",
"billingTiming": "IN_ADVANCE",
"discountClass": null,
"discountLevel": null,
"listPriceBase": "Per_Billing_Period",
"IsFreeTrial__c": "false",
"pricingSummary": [
"USD49.95"
],
"smoothingModel": null,
"CeilingPrice__c": "$49.95",
"applyDiscountTo": null,
"defaultQuantity": null,
"numberOfPeriods": null,
"upToPeriodsType": null,
"endDateCondition": "Subscription_End",
"priceChangeOption": "NoChange",
"financeInformation": {
"deferredRevenueAccountingCode": "Deferred Revenue - Quant Ratings",
"recognizedRevenueAccountingCode": "Revenue - Quant Ratings",
"deferredRevenueAccountingCodeType": "DeferredRevenue",
"recognizedRevenueAccountingCodeType": "SalesRevenue"
},
"RenewalPriceLevel1__c": "$49.95",
"RenewalPriceLevel2__c": "$49.95",
"RenewalPriceLevel3__c": "$49.95",
"RenewalPriceLevel4__c": "$49.95",
"RenewalPriceLevel5__c": "$49.95",
"specificBillingPeriod": null,
"billingPeriodAlignment": "AlignToCharge",
"priceIncreasePercentage": null,
"unusedIncludedUnitPrice": null,
"usageRecordRatingOption": null,
"overageCalculationOption": null,
"revenueRecognitionRuleName": "Recognize daily over time",
"productDiscountApplyDetails": [],
"overageUnusedUnitsCreditOption": null,
"useTenantDefaultForPriceChange": false,
"useDiscountSpecificAccountingCode": null
}]
}
}
]
}
}
The example response is quite long because Piano's Zuora integration automatically pulls in all parameters associated with these Zuora objects. That means, if Zuora were to add new parameters to these objects, those new parameters would immediately be available within Piano's offer templates.