Process Consumption Overages Action

Process consumption overages for the usage summary records with SummaryComplete status. This action uses the entitlement service to process the overages.

This action is available in API version 63.0 and later.

Special Access Rules

The Process Consumption Overages action is available in Enterprise, Developer, and Unlimited Editions where Usage Management is enabled. To use this action, you need the Usage Management Run Time User permission.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/processConsumptionOverages

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`usageRatableSummaryId`	string	Required. ID of the usage ratable summary record that contains the consumption details, and is used to calculate consumption overages and create usage entitlement entry records.

Outputs

None.

Example

POST

This example shows a sample request for the Process Consumption Overages action.

1{
2  "inputs": [
3    {
4      "usageRatableSummaryId": "3ttDU00000000iZYAQ"
5    }
6  ]
7}

This example shows a sample response for the Process Consumption Overages action.

1{
2  "actionName": "processConsumptionOverages",
3  "errors": null,
4  "isSuccess": true
5}

See Also

Salesforce Help: Permission Set Licenses, Personas, and User Permissions for Usage Management