PUT v1/SubscriptionProducts?preview={preview}&showZeroDollarCharges={showZeroDollarCharges}&temporarilyDisableAutoPost={temporarilyDisableAutoPost}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| preview | boolean |
Default value is False |
|
| showZeroDollarCharges | boolean |
Default value is False |
|
| temporarilyDisableAutoPost | boolean |
Default value is False |
Body Parameters
Common.Dto.Put.SubscriptionProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| planProductId | integer |
None. |
|
| quantity | decimal number |
Range: inclusive between 0 and 2147483647 |
|
| isIncluded | boolean |
None. |
|
| startDate | date |
None. |
|
| subscriptionProductOverride | Common.Dto.Put.SubscriptionProductOverride |
None. |
|
| subscriptionProductPriceOverride | Common.Dto.Put.SubscriptionProductPriceOverride |
None. |
|
| chargeAtSubscriptionActivation | boolean |
None. |
|
| subscriptionProductDiscount | Common.Dto.Put.SubscriptionProductDiscount |
None. |
|
| subscriptionProductDiscounts | Collection of Common.Dto.Put.SubscriptionProductDiscount |
None. |
|
| quantityChangeDescription | string |
String length: inclusive between 0 and 1000 |
|
| earningSettings | Common.Dto.Put.SubscriptionProductEarningTiming |
None. |
|
| remainingInterval | integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
|
| intervalsUntilStart | integer |
Range: inclusive between 0 and 9.22337203685478E+18 |
|
| upliftPriorToRecharge | boolean |
None. |
|
| includingInitialCharge | boolean |
None. |
|
| priceUpliftsEnabled | boolean |
None. |
|
| priceUplifts | Collection of Common.Dto.Put.SubscriptionProductPriceUplift |
None. |
|
| customServiceDateNumberOfIntervals | integer |
Range: inclusive between 0 and 99 |
|
| customServiceDateInterval | string |
None. |
|
| customServiceDateProjection | string |
None. |
|
| generateZeroDollarCharge | boolean |
None. |
|
| id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"planProductId": 1,
"quantity": 2.0,
"isIncluded": true,
"startDate": "2025-11-03T19:48:02.5110047+00:00",
"subscriptionProductOverride": {
"name": "sample string 1",
"description": "sample string 2",
"id": 3
},
"subscriptionProductPriceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 1",
"id": 2
},
"chargeAtSubscriptionActivation": true,
"subscriptionProductDiscount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4
},
"subscriptionProductDiscounts": [
{
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4
},
{
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4
}
],
"quantityChangeDescription": "sample string 5",
"earningSettings": {
"earningTimingInterval": "sample string 1",
"earningTimingType": "sample string 2",
"earningInterval": 1,
"earningNumberOfInterval": 1
},
"remainingInterval": 1,
"intervalsUntilStart": 1,
"upliftPriorToRecharge": true,
"includingInitialCharge": true,
"priceUpliftsEnabled": true,
"priceUplifts": [
{
"sequenceNumber": 1,
"remainingIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"upliftType": "sample string 5",
"upliftPriorToRecharge": true
},
{
"sequenceNumber": 1,
"remainingIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"upliftType": "sample string 5",
"upliftPriorToRecharge": true
}
],
"customServiceDateNumberOfIntervals": 9,
"customServiceDateInterval": "sample string 10",
"customServiceDateProjection": "sample string 11",
"generateZeroDollarCharge": true,
"id": 13
}
Response Information
Resource Description
Common.Dto.Get.SubscriptionProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| subscriptionId | integer |
None. |
|
| planProduct | Common.Dto.Get.PlanProduct |
None. |
|
| quantity | decimal number |
None. |
|
| isIncluded | boolean |
None. |
|
| startDate | date |
None. |
|
| subscriptionProductOverride | Common.Dto.Get.SubscriptionProductOverride |
None. |
|
| subscriptionProductPriceOverride | Common.Dto.Get.SubscriptionProductPriceOverride |
None. |
|
| chargeAtSubscriptionActivation | boolean |
None. |
|
| isCharged | boolean |
None. |
|
| subscriptionProductDiscount | Common.Dto.Get.SubscriptionProductDiscount |
None. |
|
| subscriptionProductDiscounts | Collection of Common.Dto.Get.SubscriptionProductDiscount |
None. |
|
| customFields | Collection of Common.Dto.Get.SubscriptionProductCustomField |
None. |
|
| monthlyRecurringRevenue | decimal number |
None. |
|
| netMonthlyRecurringRevenue | decimal number |
None. |
|
| amount | decimal number |
None. |
|
| status | string |
None. |
|
| invoicePreview | Common.Dto.Get.InvoicePreview |
None. |
|
| lastPurchaseDate | date |
None. |
|
| earningSettings | Common.Dto.Get.SubscriptionProductEarningTiming |
None. |
|
| remainingInterval | integer |
None. |
|
| intervalsUntilStart | integer |
None. |
|
| groupQuantityChangeCharges | boolean |
None. |
|
| priceUpliftsEnabled | boolean |
None. |
|
| priceUplifts | Collection of Common.Dto.Get.SubscriptionProductPriceUplift |
None. |
|
| upliftPriorToRecharge | boolean |
None. |
|
| includingInitialCharge | boolean |
None. |
|
| historicalPriceUplifts | Collection of Common.Dto.Get.SubscriptionProductPriceUpliftHistory |
None. |
|
| customServiceDateNumberOfIntervals | integer |
None. |
|
| customServiceDateInterval | string |
None. |
|
| customServiceDateProjection | string |
None. |
|
| modifiedTimestamp | date |
None. |
|
| salesforceId | string |
None. |
|
| generateZeroDollarCharge | boolean |
None. |
|
| trackPeakQuantity | boolean |
None. |
|
| peakQuantity | decimal number |
None. |
|
| pricebookId | integer |
None. |
|
| id | integer |
None. |
|
| uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"subscriptionId": 1,
"planProduct": {
"status": "sample string 1",
"productId": 2,
"planId": 3,
"productCode": "sample string 4",
"productName": "sample string 5",
"productStatus": "sample string 6",
"productDescription": "sample string 7",
"productType": "sample string 8",
"productGLCode": "sample string 9",
"quantity": 10.0,
"maxQuantity": 1.0,
"isRecurring": true,
"isUsed": true,
"isFixed": true,
"isOptional": true,
"isIncludedByDefault": true,
"isTrackingItems": true,
"chargeAtSubscriptionActivation": true,
"orderToCashCycles": [
{
"planFrequencyId": 1,
"planProductId": 2,
"numberOfIntervals": 3,
"interval": "sample string 4",
"chargeModels": [
{
"chargeModelType": "sample string 1",
"chargeTimingType": "sample string 2",
"prorationGranularity": "sample string 3",
"prorateOnPositiveQuantity": true,
"prorateOnNegativeQuantity": true,
"reverseChargeOnNegativeQuantity": true,
"id": 7,
"uri": "sample string 8"
},
{
"chargeModelType": "sample string 1",
"chargeTimingType": "sample string 2",
"prorationGranularity": "sample string 3",
"prorateOnPositiveQuantity": true,
"prorateOnNegativeQuantity": true,
"reverseChargeOnNegativeQuantity": true,
"id": 7,
"uri": "sample string 8"
}
],
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
}
],
"remainingInterval": 1,
"intervalsUntilStart": 1,
"groupQuantityChangeCharges": true,
"planProductPriceUplifts": [
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"currency": "sample string 5",
"upliftType": "sample string 6"
},
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"currency": "sample string 5",
"upliftType": "sample string 6"
}
],
"customServiceDateNumberOfIntervals": 6,
"customServiceDateInterval": "sample string 7",
"customServiceDateProjection": "sample string 8",
"upliftPriorToRecharge": true,
"includingInitialCharge": true,
"trackPeakQuantity": true,
"pricebookId": 1,
"pricebook": {
"name": "sample string 1",
"description": "sample string 2",
"code": "sample string 3",
"createdTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"modifiedTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"deletable": true,
"defaultPrice": {
"id": 1,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
},
"pricebookEntries": [
{
"priority": 1,
"salesTrackingCode1Id": 1,
"salesTrackingCode1Name": "sample string 2",
"salesTrackingCode1Code": "sample string 3",
"salesTrackingCode2Id": 1,
"salesTrackingCode2Name": "sample string 4",
"salesTrackingCode2Code": "sample string 5",
"salesTrackingCode3Id": 1,
"salesTrackingCode3Name": "sample string 6",
"salesTrackingCode3Code": "sample string 7",
"salesTrackingCode4Id": 1,
"salesTrackingCode4Name": "sample string 8",
"salesTrackingCode4Code": "sample string 9",
"salesTrackingCode5Id": 1,
"salesTrackingCode5Name": "sample string 10",
"salesTrackingCode5Code": "sample string 11",
"id": 12,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
},
{
"priority": 1,
"salesTrackingCode1Id": 1,
"salesTrackingCode1Name": "sample string 2",
"salesTrackingCode1Code": "sample string 3",
"salesTrackingCode2Id": 1,
"salesTrackingCode2Name": "sample string 4",
"salesTrackingCode2Code": "sample string 5",
"salesTrackingCode3Id": 1,
"salesTrackingCode3Name": "sample string 6",
"salesTrackingCode3Code": "sample string 7",
"salesTrackingCode4Id": 1,
"salesTrackingCode4Name": "sample string 8",
"salesTrackingCode4Code": "sample string 9",
"salesTrackingCode5Id": 1,
"salesTrackingCode5Name": "sample string 10",
"salesTrackingCode5Code": "sample string 11",
"id": 12,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
}
],
"priceLimits": [
{
"amount": 1.0,
"currency": "sample string 2"
},
{
"amount": 1.0,
"currency": "sample string 2"
}
],
"id": 7,
"uri": "sample string 8"
},
"earningInterval": "sample string 10",
"earningNumberOfIntervals": 1,
"earningTimingInterval": "sample string 11",
"earningTimingType": "sample string 12",
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"earningSchedules": [
{
"currency": "sample string 1",
"schedules": [
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
},
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
}
]
},
{
"currency": "sample string 1",
"schedules": [
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
},
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
}
]
}
],
"amounts": [
{
"currency": "sample string 1",
"amount": 2.0
},
{
"currency": "sample string 1",
"amount": 2.0
}
],
"id": 13,
"uri": "sample string 14"
},
{
"planFrequencyId": 1,
"planProductId": 2,
"numberOfIntervals": 3,
"interval": "sample string 4",
"chargeModels": [
{
"chargeModelType": "sample string 1",
"chargeTimingType": "sample string 2",
"prorationGranularity": "sample string 3",
"prorateOnPositiveQuantity": true,
"prorateOnNegativeQuantity": true,
"reverseChargeOnNegativeQuantity": true,
"id": 7,
"uri": "sample string 8"
},
{
"chargeModelType": "sample string 1",
"chargeTimingType": "sample string 2",
"prorationGranularity": "sample string 3",
"prorateOnPositiveQuantity": true,
"prorateOnNegativeQuantity": true,
"reverseChargeOnNegativeQuantity": true,
"id": 7,
"uri": "sample string 8"
}
],
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"defaultValue": {}
}
],
"remainingInterval": 1,
"intervalsUntilStart": 1,
"groupQuantityChangeCharges": true,
"planProductPriceUplifts": [
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"currency": "sample string 5",
"upliftType": "sample string 6"
},
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"amount": 3.0,
"repeatForever": true,
"currency": "sample string 5",
"upliftType": "sample string 6"
}
],
"customServiceDateNumberOfIntervals": 6,
"customServiceDateInterval": "sample string 7",
"customServiceDateProjection": "sample string 8",
"upliftPriorToRecharge": true,
"includingInitialCharge": true,
"trackPeakQuantity": true,
"pricebookId": 1,
"pricebook": {
"name": "sample string 1",
"description": "sample string 2",
"code": "sample string 3",
"createdTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"modifiedTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"deletable": true,
"defaultPrice": {
"id": 1,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
},
"pricebookEntries": [
{
"priority": 1,
"salesTrackingCode1Id": 1,
"salesTrackingCode1Name": "sample string 2",
"salesTrackingCode1Code": "sample string 3",
"salesTrackingCode2Id": 1,
"salesTrackingCode2Name": "sample string 4",
"salesTrackingCode2Code": "sample string 5",
"salesTrackingCode3Id": 1,
"salesTrackingCode3Name": "sample string 6",
"salesTrackingCode3Code": "sample string 7",
"salesTrackingCode4Id": 1,
"salesTrackingCode4Name": "sample string 8",
"salesTrackingCode4Code": "sample string 9",
"salesTrackingCode5Id": 1,
"salesTrackingCode5Name": "sample string 10",
"salesTrackingCode5Code": "sample string 11",
"id": 12,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
},
{
"priority": 1,
"salesTrackingCode1Id": 1,
"salesTrackingCode1Name": "sample string 2",
"salesTrackingCode1Code": "sample string 3",
"salesTrackingCode2Id": 1,
"salesTrackingCode2Name": "sample string 4",
"salesTrackingCode2Code": "sample string 5",
"salesTrackingCode3Id": 1,
"salesTrackingCode3Name": "sample string 6",
"salesTrackingCode3Code": "sample string 7",
"salesTrackingCode4Id": 1,
"salesTrackingCode4Name": "sample string 8",
"salesTrackingCode4Code": "sample string 9",
"salesTrackingCode5Id": 1,
"salesTrackingCode5Name": "sample string 10",
"salesTrackingCode5Code": "sample string 11",
"id": 12,
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
}
}
],
"priceLimits": [
{
"amount": 1.0,
"currency": "sample string 2"
},
{
"amount": 1.0,
"currency": "sample string 2"
}
],
"id": 7,
"uri": "sample string 8"
},
"earningInterval": "sample string 10",
"earningNumberOfIntervals": 1,
"earningTimingInterval": "sample string 11",
"earningTimingType": "sample string 12",
"pricingModel": {
"pricingModelType": "sample string 1",
"quantityRanges": [
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
},
{
"min": 1.0,
"max": 1.0,
"prices": [
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
},
{
"amount": 1.0,
"conditionAmount": 1.0,
"variableAmount": 1.0,
"currency": "sample string 1",
"conditionAmountDays": 1,
"id": 2,
"uri": "sample string 3"
}
],
"id": 2,
"uri": "sample string 3"
}
],
"pricingFormulaType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"earningSchedules": [
{
"currency": "sample string 1",
"schedules": [
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
},
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
}
]
},
{
"currency": "sample string 1",
"schedules": [
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
},
{
"scheduledInterval": "sample string 1",
"numberOfIntervals": 1,
"scheduledAmount": 1.0,
"reference": "sample string 2",
"scheduledType": "sample string 3",
"id": 4,
"uri": "sample string 5"
}
]
}
],
"amounts": [
{
"currency": "sample string 1",
"amount": 2.0
},
{
"currency": "sample string 1",
"amount": 2.0
}
],
"id": 13,
"uri": "sample string 14"
}
],
"resetType": "sample string 18",
"planProductUniqueId": 19,
"sortOrder": 20,
"generateZeroDollarCharge": true,
"hostedPageManagedOfferingPlanProduct": {
"visible": true,
"inclusionManagement": true,
"quantityManagement": true,
"planProductKeyId": 4
},
"id": 22,
"uri": "sample string 23"
},
"quantity": 2.0,
"isIncluded": true,
"startDate": "2025-11-03T19:48:02.5293206+00:00",
"subscriptionProductOverride": {
"name": "sample string 1",
"description": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"subscriptionProductPriceOverride": {
"chargeAmount": 1.0,
"priceRanges": [
{
"min": 1.0,
"max": 1.0,
"price": 2.0
},
{
"min": 1.0,
"max": 1.0,
"price": 2.0
}
],
"pricingModelType": "sample string 2",
"id": 3,
"uri": "sample string 4"
},
"chargeAtSubscriptionActivation": true,
"isCharged": true,
"subscriptionProductDiscount": {
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
"subscriptionProductDiscounts": [
{
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
},
{
"discountType": "sample string 1",
"amount": 2.0,
"remainingUsagesUntilStart": 3,
"remainingUsage": 1,
"id": 4,
"uri": "sample string 5"
}
],
"customFields": [
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
},
{
"key": "sample string 1",
"friendlyName": "sample string 2",
"dataType": "sample string 3",
"value": {}
}
],
"monthlyRecurringRevenue": 6.0,
"netMonthlyRecurringRevenue": 7.0,
"amount": 8.0,
"status": "sample string 9",
"invoicePreview": {
"draftCharges": [
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
},
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
}
],
"subtotal": 1.0,
"total": 2.0,
"draftTaxes": [
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
},
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
}
],
"tax": {
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
},
"totalTaxes": 3.0,
"totalDiscount": 4.0,
"poNumber": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"status": "sample string 7",
"draftChargeGroups": [
{
"name": "sample string 1",
"description": "sample string 2",
"reference": "sample string 3",
"subscriptionId": 1,
"draftCharges": [
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
},
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
}
]
},
{
"name": "sample string 1",
"description": "sample string 2",
"reference": "sample string 3",
"subscriptionId": 1,
"draftCharges": [
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
},
{
"transactionId": 1,
"chargeTypeId": "sample string 2",
"transactionType": "sample string 3",
"quantity": 4.0,
"unitPrice": 5.0,
"amount": 6.0,
"taxableAmount": 7.0,
"subscriptionPeriodId": 8,
"draftInvoiceId": 9,
"name": "sample string 10",
"description": "sample string 11",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"endServiceDate": "2025-11-03T19:48:02.5293206+00:00",
"rangeQuantity": 1.0,
"draftDiscount": {
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
"draftDiscounts": [
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"draftChargeId": 1,
"configuredDiscountAmount": 2.0,
"amount": 3.0,
"quantity": 4.0,
"discountType": "sample string 5",
"effectiveTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"status": "sample string 15",
"productItems": null,
"canProrateCharge": true,
"postable": true,
"subscriptionProductId": 1,
"purchaseId": 1,
"productId": 1,
"draftChargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0,
"sortOrder": 5
}
],
"hasPurchasePerformanceObligations": true,
"id": 19,
"uri": "sample string 20"
}
]
}
],
"notes": "sample string 8",
"shippingInstructions": "sample string 9",
"openingArBalance": 10.0,
"closingArBalance": 11.0,
"creditFromAvailableFunds": 12.0
},
"lastPurchaseDate": "2025-11-03T19:48:02.5293206+00:00",
"earningSettings": {
"earningTimingInterval": "sample string 1",
"earningTimingType": "sample string 2",
"earningInterval": "sample string 3",
"earningNumberOfInterval": 1
},
"remainingInterval": 1,
"intervalsUntilStart": 1,
"groupQuantityChangeCharges": true,
"priceUpliftsEnabled": true,
"priceUplifts": [
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"remainingIntervals": 3,
"amount": 4.0,
"upliftType": "sample string 5",
"repeatForever": true,
"upliftPriorToRecharge": true
},
{
"sequenceNumber": 1,
"numberOfIntervals": 2,
"remainingIntervals": 3,
"amount": 4.0,
"upliftType": "sample string 5",
"repeatForever": true,
"upliftPriorToRecharge": true
}
],
"upliftPriorToRecharge": true,
"includingInitialCharge": true,
"historicalPriceUplifts": [
{
"consumedTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"originalAmount": 1.0,
"increasedAmount": 1.0,
"sequenceNumber": 2,
"numberOfIntervals": 3,
"remainingIntervals": 4,
"amount": 5.0,
"upliftType": "sample string 6",
"repeatForever": true,
"upliftPriorToRecharge": true
},
{
"consumedTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"originalAmount": 1.0,
"increasedAmount": 1.0,
"sequenceNumber": 2,
"numberOfIntervals": 3,
"remainingIntervals": 4,
"amount": 5.0,
"upliftType": "sample string 6",
"repeatForever": true,
"upliftPriorToRecharge": true
}
],
"customServiceDateNumberOfIntervals": 14,
"customServiceDateInterval": "sample string 15",
"customServiceDateProjection": "sample string 16",
"modifiedTimestamp": "2025-11-03T19:48:02.5293206+00:00",
"salesforceId": "sample string 18",
"generateZeroDollarCharge": true,
"trackPeakQuantity": true,
"peakQuantity": 1.0,
"pricebookId": 1,
"id": 21,
"uri": "sample string 22"
}