GET v1/PlanProducts/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Common.Dto.Get.PlanProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| status | string |
None. |
|
| productId | integer |
None. |
|
| planId | integer |
None. |
|
| productCode | string |
None. |
|
| productName | string |
None. |
|
| productStatus | string |
None. |
|
| productDescription | string |
None. |
|
| productType | string |
None. |
|
| productGLCode | string |
None. |
|
| quantity | decimal number |
None. |
|
| maxQuantity | decimal number |
None. |
|
| isRecurring | boolean |
None. |
|
| isUsed | boolean |
None. |
|
| isFixed | boolean |
None. |
|
| isOptional | boolean |
None. |
|
| isIncludedByDefault | boolean |
None. |
|
| isTrackingItems | boolean |
None. |
|
| chargeAtSubscriptionActivation | boolean |
None. |
|
| orderToCashCycles | Collection of Common.Dto.Get.PlanOrderToCashCycle |
None. |
|
| resetType | string |
None. |
|
| planProductUniqueId | integer |
None. |
|
| changeSummary | Common.Dto.Get.PlanChangeSummary |
None. |
|
| changePreview | Common.Dto.Get.PlanChangeSummary |
None. |
|
| sortOrder | integer |
None. |
|
| generateZeroDollarCharge | boolean |
None. |
|
| hostedPageManagedOfferingPlanProduct | Common.Dto.Get.HostedPageManagedOfferingPlanProduct |
None. |
|
| id | integer |
None. |
|
| uri | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"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-05-21T01:34:27.2690131+00:00",
"modifiedTimestamp": "2025-05-21T01:34:27.2690131+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-05-21T01:34:27.2690131+00:00",
"modifiedTimestamp": "2025-05-21T01:34:27.2690131+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"
}