Revenue | Get Usage Details
Gets the details of the consumption overages for up to five usage resources associated with an account by using the account ID.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions of Revenue Cloud Advanced and Revenue Cloud Billing with the Agentforce Employee Agent add-on. It also requires the Flex Credits Metering add-on and the Usage Management add-on. |
| User Permissions Needed | |
|---|---|
| See Common User Access for Standard Agent Actions. | |
Action Details
| API Name | GetUsageDetails |
| Reference Action Type | Prompt |
| Reference Action | Get Usage Details |
| Does this action execute one or more prompt templates? | Yes |
| Required Setup | Quote Management with Agentforce |
Guidelines and Considerations
- You can only request up to five accounts in an agent request.
- The agent supports only anchor products with usage resources of type usage.
- The agent provides the overage details in the equivalent amount that is to be billed for the current billing cycle.
- The agent can create a quote with only Pack usage type products.
- When you use the agent to check for overages, and then ask the agent to create a quote for the over-consumed usage resource, you must add the term usage resource in the request. For example, if the account has over-consumed 50-GB data storage, then you must say, create a quote for the account Acme with the data storage usage resource.
- The overage details that the agent returns are before liable summary generation. After the liable summaries are generated for a period, overage details won’t be returned.
Get Usage Details and Prompt Template
The Get Account Usage Details agent action uses Get Account Usage Details prompt template to retrieve consumption details of the usage resources associated with accounts.
The action passes the required input parameter account IDs. The parameter includes the list of comma-delimited account IDs whose usage details are to be fetched.
Did this article solve your issue?
Let us know so we can improve!

