Rate Limiting and Billing | MuleSoft Documentation
# Rate Limiting and Billing
Object Store v2 uses two metrics to determine rate-limiting and billing: API requests and effective API requests. Depending on your Anypoint Platform instance, you access usage data in Access Management or Usage.
  * US Cloud or EU Cloud
  * Canada Cloud or Japan Cloud



API Requests
    
API requests are HTTP transactions, such as GET, PUT, and POST.
Object Store uses successful API requests (2xx) to calculate transactions per second (TPS) for rate limiting.
See Rate Limiting. 

Effective API Requests
    
Effective API requests are the units that Object Store uses to calculate billing.
One successful API request could generate many effective API requests.
See How Billing is Calculated.
The Object Store UI shows effective API request data for two months: the current and previous month.   
---  
## Rate Limiting
Every successful API request (via the connector or API) to Object Store v2 counts toward the TPS limit, based on your subscription type:
Subscription Type | TPS Limit  
---|---  
Base subscription | 10 TPS per store  
Premium add-on subscription | 100 TPS per store  
For example, if your app retrieves 1500 keys from an object store with a page size of 25:
  * With the base subscription, the response is throttled over 6 seconds.
  * With the premium subscription, the response isn’t throttled.


If the store exceeds the number of TPS allotted based on the subscription type, Object Store v2 returns a `429 HTTP Error` response, indicating that it reached the rate limit.
If the store reaches the TPS limit, you can either upgrade to a premium subscription or redesign the app to send API requests more slowly.
Requests that return a 429 response (due to rate limiting) don’t count toward your monthly billing usage and quota.   
---  
## How Billing is Calculated
All effective API requests that return a 2xx (success) response count toward your monthly billing usage and quota.
An effective API request counts as **one or more units** against the quota, depending on the size of the payload and the number of keys returned.
  * Each API request up to 100 KB of object-payload data (if applicable) counts as one unit against the quota.
For example, if an app retrieves one key from an object store with a total payload size of 500KB, the request counts as five units against the quota.
  * Each 100 KB of payload data above 100 KB counts as an additional unit.
For example, if an app inserts, updates, or retrieves an item with a total payload size of 101KB from an object store, the operation counts as two units against the quota.
  * For the Retrieve All and Retrieve All Keys operations, the size of all key-value pairs in the object store partition counts toward billable units.
For example, if an app runs the Retrieve All Keys operation to retrieve only the keys in the object store, the billable unit is based on the size of the key-value pairs, not just the keys.
  * For each Store operation, the size of the item being inserted or updated counts toward billable units.
For example, if an app inserts or updates one key in an object store with a total payload size of 300KB, the request counts as three units against the quota.
  * Each DELETE API call counts as a single billable unit. Additional units apply to deleted partitions.
API Call | Description | Billable Units  
---|---|---  
Delete store | Deletes the store, all partitions in the store, and all key-value pairs in each partition | 
    * One billable unit for the DELETE API call
    * One billable unit for each deleted partition in the store  
Delete partitions in store | Deletes all partitions in the store, including the key-value pairs in each partition | 
    * One billable unit for the DELETE API call
    * One billable unit for each deleted partition in the store  
Delete partition | Deletes all key-value pairs and then deletes the partition | One billable unit  
Delete all keys and values in the partition | Deletes every key and its associated value from the specified partition | One billable unit  
Delete key | Deletes a single key and its associated value | One billable unit  
For example, a call to delete a store with two partitions counts as three billable units against the quota:
    * DELETE API call: one billable unit
    * Two partitions: two billable units


## Maximum Number of API Requests Per Month
This table lists the maximum number of API requests per month, based on your subscription type:
Subscription Type | Maximum API Requests Per Month  
---|---  
Base subscription | 26 million  
Premium add-on subscription | 100 million per add-on subscription  
If your usage exceeds your license limit, Object Store v2 continues to work. MuleSoft notifies your account administrator and team of any billing-related information.
## Access Effective API Request Usage Charts
Only the US Cloud and EU Cloud instances of Anypoint Platform support this feature.   
---  
To view a chart that shows how many effective API requests your apps have consumed and the number of effective API requests that your subscription allows:
  1. In Anypoint Platform, go to **Access Management**.
  2. Click **Object Store** in the **Subscription** section:
The chart shows usage stats for the current and previous month:
Percentage and amount of your quota that you have used  If the usage is 0, the chart displays `<1%`. The circle graph changes to red as your effective API request usage approaches your quota: |  Monthly billing usage information might be delayed by up to 24 hours.   
---  
Subscription type 
     * `Base 0.0` indicates the Base subscription.
     * Base values greater than `0.0` indicate Premium add-on subscriptions.  


In some cases, the stats for the current month might not load when the backend process updates the records. If this happens, use the Object Store v2 Stats API Usage Metrics by Organization to query the daily usage in the current month and then add the daily usage together.
## Access Effective API Request Usage Reports
Only the Canada Cloud and Japan Cloud instances of Anypoint Platform support this feature.   
---  
To view Object Store usage reports in Usage:
  1. In Anypoint Platform, go to **Usage**.
  2. Select **Object Store** in the **Product** section:
  3. Select a month from the **Monthly Usage Report** tab or day from the **Daily Usage Report** tab.
The report shows:
     * Total effective API requests for the selected period
     * Effective API requests by store
  4. Click **Export as CSV** to download the usage date for the selected period.


For more information, see Usage Reports.
## Retrieve Usage Metrics with Object Store v2 Stats API
Only the US Cloud and EU Cloud instances of Anypoint Platform support this feature.   
---  
To use the Object Store v2 Stats API to retrieve usage metrics, see:
  * Get Usage Metrics by Organization
  * Get Usage Metrics by Environment
  * Get Usage Metrics by Region
  * Get Usage Metrics by Store


## See Also
  *