Rate Plan (GET)

Get a rate plan for a specified set of context input. Use this API to retrieve rate cards, rate card entries, and related adjustments based on the filter criteria for the context input.

Keep these considerations in mind when you use this API.

This API request supports one pricebook and one sellable product.
The ID of the product is required to invoke this API.
Invoke this API even if a hydrated context is available to fetch the rate card, rate card entry, and adjustment details.

Special Access Rules

The org must have the Rate Management: Run Time User permission set to use this API. Additionally, the org must also have a default usage rating discovery procedure defined in the Revenue Settings from Setup.

Resource

1/connect/core-rating/rate-plan

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/core-rating/rate-plan?contextId=858a3ad3e5a0e5c319652a6ab92f6fdb2b4fa8be72b390506d014596c6da62c9&procedureApiName=SampleProcedure

Available Version

62.0

HTTP Methods

GET

Request Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`contextId`	String	ID of the context to specify as an input to the procedure.	Required	62.0
`procedureApiName`	String	API name of the procedure to be executed.	Required	62.0

Response Body for GET

Rate Plan Response