Price Agreements REST Endpoints
Pricing Setup/Price Agreements
These endpoints support administration of CPQ Price Agreements, Price Agreement Items, Price Agreement stand-alone Charges, Price Agreement Rate Plans, and Price Agreement Rate Plan Charges.
- Add a Price Agreement
- Method: postPath:
/rest/v19/pricingSetup/agreements
- Add a Price Agreement Item
- Method: postPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems
- Add a Price Agreement Item Charge
- Method: postPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges
- Add a Price Agreement Item Rate Plan
- Method: postPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Add a Price Agreement Item Rate Plan Charge
- Method: postPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Delete a Price Agreement
- Method: deletePath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}
- Delete a Price Agreement Item
- Method: deletePath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}
- Delete a Price Agreement Item Charge
- Method: deletePath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Delete a Price Agreement Item Rate Plan
- Method: deletePath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Delete a Price Agreement Item Rate Plan Charge
- Method: deletePath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get a Price Agreement
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}
- Get a Price Agreement Item
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}
- Get a Price Agreement Item Charge
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Get a Price Agreement Item Rate Plan
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Get a Price Agreement Item Rate Plan Charge
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Get a Price Agreement Pricing Data Item
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/data/{id}
- Get All Price Agreement Item Charges
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges
- Get All Price Agreement Item Rate Plan Charges
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Get All Price Agreement Item Rate Plans
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Get All Price Agreement Items
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems
- Get All Price Agreement Pricing Data
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/data
- Get All Price Agreements
- Method: getPath:
/rest/v19/pricingSetup/agreements
- Get Price Agreement Pricing Matrix Grid Data
- Method: getPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/matrixGrid
- Update a Price Agreement
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}
- Update a Price Agreement Item Charge
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges/{id}
- Update a Price Agreement Item Rate Plan
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}
- Update a Price Agreement Item Rate Plan Charge
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges/{id}
- Update Price Agreement Item Charges
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/charges
- Update Price Agreement Item Rate Plan Charges
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans/{ratePlanNumber}/charges
- Update Price Agreement Item Rate Plans
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/priceAgreementItems/{priceAgreementItemId}/ratePlans
- Update Price Agreement Pricing Data
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/data
- Update Price Agreement Pricing Matrix Grid Data
- Method: patchPath:
/rest/v19/pricingSetup/agreements/{agreementVariableName}/matrixGrid
- Update Price Agreements
- Method: patchPath:
/rest/v19/pricingSetup/agreements