| Name | Description | Schema | Default | Example |
|---|---|---|---|---|
|
policyId optional |
Id of policy |
string | null |
0c6439fd-9b16-3c2e-be6e-1086e0b9aa93 |
|
policyName required |
Name of policy |
string | null |
Policy1 |
|
displayName optional |
Display name of the policy |
string | null |
|
|
description optional |
Description of the policy |
string | null |
|
|
isDeployed optional |
Indicates whether the policy is deployed successfully or not. |
boolean | null |
|
|
defaultLimit optional |
ThrottleLimit | null |
||
|
monetization optional |
MonetizationInfo | null |
||
|
rateLimitCount optional |
Burst control request count |
integer | null |
10 |
|
rateLimitTimeUnit optional |
Burst control time unit |
string | null |
|
|
customAttributes optional |
Custom attributes added to the Subscription Throttling Policy |
array | null |
{} |
|
stopOnQuotaReach optional |
This indicates the action to be taken when a user goes beyond the allocated quota. If checked, the user's requests will be dropped. If unchecked, the requests will be allowed to pass through. |
boolean | null |
|
|
billingPlan optional |
define whether this is Paid or a Free plan. Allowed values are FREE or COMMERCIAL. |
string | null |