Quick Start
Set up your environment and then use the PDC REST API to make your first API call by performing these tasks:
Prerequisites
| Prerequisite | More Information |
|---|---|
| Install Pricing Design Center | "Installing Pricing Design Center" in PDC Installation Guide |
| Install cURL | Use cURL |
Send a Request
After you set up your REST client, you can send a request to ensure that your connection works. For example, to retrieve all pricing data in your system, send the following request:
curl -X GET 'http://hostname:port/pdc/pricing'
where:
-
hostname is the URL for the PDC REST server.
-
port is the port for the PDC REST server.
If the request is successful, you should receive response code 200 along with a response body similar to the following:
{
"priceModel": [
{
"name": "samplePrice_mar9",
"internalId": "56db3762-cf93-40ce-9d69-036459cbf72e",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"usageChargePopModel": {
"priceTier": [
{
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"rumTierExpression": {}
},
"enforceCreditLimit": "DEFAULT",
"rumName": "Duration",
"currencyCode": "BEF",
"priceTierValidityPeriod": [
{
"lowerBound": "0",
"validFrom": "0",
"priceTierRange": [
{
"upperBoundExpression": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"scaledCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 56,
"priceType": "CONSUMPTION",
"incrementStep": 1.0,
"incrementRounding": "NONE"
}
]
}
]
}
],
"applicableQuantity": "ORIGINAL"
}
]
}
}
],
"timeModel": [
{
"name": "sampleTimeModel_mar9",
"description": "sampleTimeModel",
"internalId": "93c3f33d-21da-497f-9b95-ccdf5703af01",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"validityPeriod": [
{
"validFrom": "0",
"timeModelTag": [
{
"tagName": "feb10",
"timeSpecification": [
{
"name": "feb10",
"timeOfDay": "T000000/T000000"
}
]
}
]
}
]
}
],
"taxExemptionSelector": [
{
"name": "sampleTES",
"description": "Editing tax exemption selector",
"internalId": "9c418738-bdfd-4732-a1ae-0ea571c3d52b",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"stereoType": "TAX_EXEMPTION_SELECTOR",
"productSpecName": "TelcoGsmTelephony",
"eventSpecName": "EventBillingProductFeeCycleCycle_forward_monthly",
"customerSpecName": "Account",
"validityPeriod": [
{
"validFrom": "0",
"rule": [
{
"result": [
{
"resultName": "toll"
}
],
"fieldToValueExpression": [
{
"operation": "EQUAL_TO",
"separator": ";",
"fieldName": "EventBillingProductFeeCycleCycle_forward_monthly.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
}
]
}
]
}
],
"modelData": [
{
"key": "FIELD_COUNT",
"value": "1"
},
{
"key": "field_0.name",
"value": "EventBillingProductFeeCycleCycle_forward_monthly.END_T"
},
{
"key": "field_0.kind",
"value": "EVENT_SPEC_FIELD"
},
{
"key": "field_0.valueType",
"value": "SINGLE_VALUE"
},
{
"key": "field_0.defaultValue",
"value": "*"
},
{
"key": "field_0.operator",
"value": "EQUAL_TO"
}
]
}
],
"genericSelector": [
{
"name": "sampleGS_mar9",
"description": "Editing generic selector",
"internalId": "cbd9b51c-ad18-4a73-8b79-3d36eba8cd88",
"pricingProfileName": "Convergent Usage",
"priceListName": "Default",
"stereoType": "GENERIC_SELECTOR",
"productSpecName": "TelcoGsmTelephony",
"eventSpecName": "EventDelayedSessionTelcoGsm",
"validityPeriod": [
{
"validFrom": "0",
"rule": [
{
"name": "rule_gs",
"result": [
{
"resultName": "*"
}
],
"fieldToValueExpression": [
{
"operation": "EQUAL_TO",
"separator": ";",
"fieldName": "EventDelayedSessionTelcoGsm.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
},
{
"operation": "EQUAL_TO",
"separator": ";",
"fieldName": "EventDelayedSessionTelcoGsm.END_T",
"fieldValue": "*",
"fieldKind": "EVENT_SPEC_FIELD"
}
]
}
]
}
],
"modelData": [
{
"key": "FIELD_COUNT",
"value": "1"
},
{
"key": "field_0.name",
"value": "EventDelayedSessionTelcoGsm.END_T"
},
{
"key": "field_0.kind",
"value": "EVENT_SPEC_FIELD"
},
{
"key": "field_0.valueType",
"value": "SINGLE_VALUE"
},
{
"key": "field_0.defaultValue",
"value": "*"
},
{
"key": "field_0.operator",
"value": "EQUAL_TO"
}
]
}
],
"chargeRatePlan": [
{
"name": "sample_CRP_mar9",
"internalId": "204c6424-215a-47af-a6a3-5e4e333c7f7e",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"applicableRums": [
"Occurrence"
],
"applicableQuantity": "ORIGINAL",
"taxTime": "NONE",
"todMode": "START_TIME",
"applicableQtyTreatment": "CONTINUOUS",
"permittedName": "TelcoGsmTelephony",
"permittedType": "PRODUCT",
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"cycleFeeFlag": 0,
"billOffset": 0,
"subscriberCurrency": [
{
"currencyCode": [
"USD"
],
"crpRelDateRange": [
{
"absoluteDateRange": {
"startDate": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_mar10",
"internalId": "d19731c1-b54c-4b9c-b9df-71cdfed9e7b0",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"applicableRums": [
"Occurrence"
],
"applicableQuantity": "ORIGINAL",
"taxTime": "NONE",
"todMode": "START_TIME",
"applicableQtyTreatment": "CONTINUOUS",
"permittedName": "TelcoGsmTelephony",
"permittedType": "PRODUCT",
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"cycleFeeFlag": 0,
"billOffset": 0,
"subscriberCurrency": [
{
"currencyCode": [
"USD"
],
"crpRelDateRange": [
{
"absoluteDateRange": {
"startDate": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "charge320",
"internalId": "f16c4bae-c056-432a-ba3c-313c09999794",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"applicableRums": [
"Occurrence"
],
"applicableQuantity": "ORIGINAL",
"taxTime": "NONE",
"todMode": "START_TIME",
"applicableQtyTreatment": "CONTINUOUS",
"permittedName": "TelcoGsmTelephony",
"permittedType": "PRODUCT",
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"cycleFeeFlag": 0,
"billOffset": 0,
"subscriberCurrency": [
{
"currencyCode": [
"USD"
],
"crpRelDateRange": [
{
"absoluteDateRange": {
"startDate": "0",
"endDate": "inf"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_mar11",
"internalId": "98f66b36-2ced-4a3b-b3ec-e6ff329cbc61",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"applicableRums": [
"Occurrence"
],
"applicableQuantity": "ORIGINAL",
"taxTime": "NONE",
"todMode": "START_TIME",
"applicableQtyTreatment": "CONTINUOUS",
"permittedName": "TelcoGsmTelephony",
"permittedType": "PRODUCT",
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"cycleFeeFlag": 0,
"billOffset": 0,
"subscriberCurrency": [
{
"currencyCode": [
"USD"
],
"crpRelDateRange": [
{
"absoluteDateRange": {
"startDate": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_CRP_feb20",
"description": "March 9 edit",
"internalId": "765c08fa-d823-4823-8625-24b66477e8cd",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"applicableRums": [
"Occurrence"
],
"applicableQuantity": "ORIGINAL",
"taxTime": "NONE",
"todMode": "START_TIME",
"applicableQtyTreatment": "CONTINUOUS",
"permittedName": "TelcoGsmTelephony",
"permittedType": "PRODUCT",
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"cycleFeeFlag": 0,
"billOffset": 0,
"subscriberCurrency": [
{
"currencyCode": [
"USD"
],
"crpRelDateRange": [
{
"absoluteDateRange": {
"startDate": "20230213T000000",
"endDate": "20230223T000000"
},
"crpCompositePopModel": {
"name": "Pricing",
"recurringPopModel": {
"priceTier": {
"lowerBound": "NO_MIN",
"tierBasis": {
"rumTierExpression": {}
},
"rumName": "Occurrence",
"enforceCreditLimit": "NORMAL",
"tierRange": [
{
"upperBound": "NO_MAX",
"recurringCharge": [
{
"price": 10.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"priceType": "CONSUMPTION",
"impactType": "SCALED"
}
]
}
]
}
}
}
}
]
}
]
}
],
"alterationRatePlan": [
{
"name": "discounForDS",
"internalId": "a5737806-cdef-4efb-beb3-a6e1e3907527",
"pricingProfileName": "Standard Discount",
"priceListName": "Default",
"resourcesConsumptionOrder": "RULE_ORDER",
"arpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"alterationConfiguration": [
{
"applicableChargeAndQuantity": "REMAINING_CHARGE",
"arpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "sample_Dis_mar9",
"description": "Edit discount",
"internalId": "f2b7c346-e9a9-4099-bf6d-21ffe9ade295",
"pricingProfileName": "Subscription Discount",
"priceListName": "Default",
"resourcesConsumptionOrder": "RULE_ORDER",
"arpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"alterationConfiguration": [
{
"applicableChargeAndQuantity": "REMAINING_CHARGE",
"arpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": -0.1,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
}
],
"distributionRatePlan": [
{
"name": "chgShare_mar9",
"internalId": "be32d8d4-0365-4005-bae9-5eebea328fb7",
"pricingProfileName": "Subscription ChargeSharing",
"priceListName": "Default",
"drpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"distributionConfiguration": [
{
"drpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
},
{
"name": "chgShare",
"description": "Edited Distributed rate plan",
"internalId": "86148b63-4b14-4a47-ab80-7bdd4509c6a7",
"pricingProfileName": "Subscription ChargeSharing",
"priceListName": "Default",
"drpDateRange": [
{
"startDate": "0",
"endDate": "inf",
"distributionConfiguration": [
{
"drpCompositePopModel": {
"name": "Pricing",
"alterationPopModel": {
"priceTier": {
"distributionMethod": "FROM_BAL_IMPACT",
"tierBasis": {
"chargeTierExpression": {}
},
"lowerBound": {
"numberTBExpression": {
"value": "0"
}
},
"tierRange": [
{
"upperBound": {
"numberTBExpression": {
"value": "NO_MAX"
}
},
"percentAlteration": [
{
"price": 0.0,
"unitOfMeasure": "NONE",
"balanceElementNumCode": 840,
"alterationAppliesTo": "USER",
"alterationBasedOn": {
"chargeBasisExpression": {}
},
"priceType": "GRANT",
"priceValidity": {
"startValidityMode": "IMMEDIATE",
"endValidityMode": "NEVER",
"validityRange": "0/inf",
"relativeStartOffset": -1,
"relativeEndOffset": -1
}
}
]
}
]
}
}
}
}
]
}
]
}
],
"chargeOffering": [
{
"name": "balaCO",
"internalId": "371d1d81-f63e-4c3c-b042-b164100435f5",
"externalID": "371d1d81-f63e-4c3c-b042-b164100435f5",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"offerType": "SUBSCRIPTION",
"priority": 0,
"purchaseMin": -1.0,
"purchaseMax": -1.0,
"ownMin": -1.0,
"ownMax": -1.0,
"applicableQuantity": "REMAINING",
"purchaseCycleDOM": 0,
"dateRangeImpactType": "EVENT_DATE",
"validityRounding": "NOT_SET",
"chargeEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"timezoneMode": "EVENT",
"minQuantity": 0,
"minQuantityUnit": "NONE",
"incrementQuantity": 1,
"incrementQuantityUnit": "NONE",
"roundingMode": "NEAREST",
"prorateFirst": "PRORATE_CHARGE",
"prorateLast": "PRORATE_CHARGE",
"prorateCycle": "PRORATE_CHARGE",
"chargeRatePlanInfo": {
"targetEngine": [
"RRE"
]
},
"chargeRatePlanName": "charge320",
"ratePlanIID": "f16c4bae-c056-432a-ba3c-313c09999794"
}
]
}
],
"distributionOffering": [
{
"name": "sampleCSO_mar9",
"internalId": "6d349dd4-e35b-4439-886f-7da8df5d90a3",
"externalID": "6d349dd4-e35b-4439-886f-7da8df5d90a3",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"distributionEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"distributionRatePlanInfo": {
"targetEngine": [
"BRE"
]
},
"distributionRatePlanName": "chgShare_mar9",
"ratePlanIID": "be32d8d4-0365-4005-bae9-5eebea328fb7"
}
]
},
{
"name": "sampleCSO",
"description": "Edited Distributed offer",
"internalId": "8ffc431d-035b-4aff-aa4e-7e3addcbb938",
"externalID": "8ffc431d-035b-4aff-aa4e-7e3addcbb938",
"pricingProfileName": "Product Offering",
"priceListName": "Default",
"timeRange": "0/inf",
"productSpecName": "TelcoGsmTelephony",
"distributionEventMap": [
{
"eventName": "EventBillingProductFeeCycleCycle_forward_monthly",
"distributionRatePlanInfo": {
"targetEngine": [
"BRE"
]
},
"distributionRatePlanName": "chgShare",
"ratePlanIID": "86148b63-4b14-4a47-ab80-7bdd4509c6a7"
}
]
}
],
"subscriptionTerms": [
{
"name": "samplesubscription_term_mar9",
"description": "Edited time model",
"internalId": "03b33fe0-48be-40d8-a4b8-58b480ae322f",
"pricingProfileName": "Subscription",
"priceListName": "Default",
"termLength": 1,
"termUnit": "MONTH",
"earlyTerminationOption": "ALLOWED_NO_PENALTY",
"terminationGraceLength": 0,
"terminationGraceUnit": "DAY",
"penaltyAmount": 0.0,
"penaltyBalanceElementNumCode": 0,
"penaltyRevenueGlid": 0
}
]
}