# RateLimitScope

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The scope at which a rate limiter operates. Determines the Redis key partitioning
and which identifier is extracted from the request context.

## Values

| Value | Description |
| --- | --- |
| `Global` | Platform-wide limit shared across all tenants and merchants. |
| `PerTenant` | Per-tenant limit. Keyed by the tenant identifier. |
| `PerMerchant` | Per-merchant limit. Keyed by the merchant identifier. |
| `PerEntity` | Per-entity limit (for example a specific hosted payment page instance). Keyed by the identifier of that entity. |
| `PerEndpoint` | Per-endpoint limit. Keyed by the matched endpointPattern rather than the raw request path, so a pattern containing a wildcard produces one bounded counter key instead of one key per distinct URL. |
| `PerApiKey` | Per-API-key limit. Keyed by the API key identifier (never the key secret). |
| `PerIpAddress` | Per-IP-address limit. Keyed by the resolved client IP address. |

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.