The Sponsorship Policy object
Attributes
- limits:
object
ornull
An object containing the spending limits for the sponsorship policy. The object has the following attributes:
- global:
object
ornull
An object containing the global spending limits across all users for the sponsorship policy.
- user_operation_spending:
object
ornull
An object containing the spending limit for user operations.
- amount:
number
The spending limit amount. Must be greater than 0. The API expects amounts to be provided in a currency's smallest unit. For example, to set the limit to 10 USD, provide an amount value of 1000 (that is, 1000 cents).
- currency:
enum
The currency of the spending limit amount. Currently only USD
is supported.
- maximum_user_operation_count:
number
ornull
The maximum number of user operations allowed. Must be greater than or equal to 0.
- reset_interval:
enum
ornull
The interval at which the limits reset. Possible values are never
, daily
, weekly
, or monthly
. Default is never
.
- user:
object
ornull
An object containing the per-user spending limits for the sponsorship policy.
- user_operation_spending:
object
ornull
An object containing the spending limit for user operations per user.
- amount:
number
The spending limit amount. Must be greater than 0.
- currency:
enum
The currency of the spending limit amount. Currently only USD
is supported.
- maximum_user_operation_count:
number
ornull
The maximum number of user operations allowed per user. Must be greater than or equal to 0.
- reset_interval:
enum
ornull
The interval at which the user limits reset. Possible values are never
, daily
, weekly
, or monthly
. Default is never
.
- user_operation:
object
ornull
An object containing the per-user-operation spending limits for the sponsorship policy.
- user_operation_spending:
object
ornull
An object containing the spending limit for each individual user operation.
- amount:
number
The maximum amount allowed for a single user operation. Must be greater than 0.
- currency:
enum
The currency of the spending limit amount. Currently only USD
is supported.
Example
{
"id": "sp_tangible_knight",
"policy_name": "Pimlico Example Gas Fund",
"policy_status": "active",
"created_at": "2025-05-23T15:23:38Z",
"start_time": null,
"end_time": null,
"webhook_endpoint": "https://example.com/webhook",
"webhook_enabled": true,
"chain_ids": {
"allowlist": [
10,
8453,
34443,
690,
7777777
]
},
"limits": {
"global": {
"user_operation_spending": {
"amount": 10000000,
"currency": "USD"
},
"maximum_user_operation_count": 1000,
"reset_interval": "monthly"
},
"user": {
"user_operation_spending": {
"amount": 100000,
"currency": "USD"
},
"maximum_user_operation_count": 10,
"reset_interval": "daily"
},
"user_operation": {
"user_operation_spending": {
"amount": 10000,
"currency": "USD"
}
}
}
}