One change
List Effective Spend Limits
api/admin/spend_limits/list_effective
Nearest release: v2.1.250, published an hour before this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/spend_limits/list_effective Changed · +44 / -4 lines
from line 12
- `limit: optional number` + Maximum number of members per page. A member's period rows never split across pages, so a page may carry more rows than this. Defaults to `20`. + default: 20, maximum: 1000, minimum: 1 - `page: optional string` -- `period: optional array of string` + Opaque cursor from a previous response's `next_page` field. +- `period: optional array of "daily" or "monthly" or "weekly"` + + Restrict the report to these limit periods. Omit to return one row per period each member resolves a spend limit for. + maxItems: 3 + - `"daily"` + + - `"monthly"` + + - `"weekly"` + - `user_ids: optional array of string` + Restrict the report to these members, by tagged user ID (`user_...`). At most 100 entries. + maxItems: 100 ## Returns
from line 50
- `deleted: boolean` + True only when the underlying account has been deleted. + default: false - `email_address: string or null` + The user's email address. Null when the account is unavailable or has been deleted. + - `name: string or null` + The user's current display name. Null when the account is unavailable, has been deleted, or has no name set. + - `type: "user_actor"` + Actor type. Always `user_actor`. + default: user_actor - `user_id: string` + Tagged ID of the user. + - `amount: string or null` Effective limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD). `null` means no limit applies for this row's `period` — each period resolves independently, so another period may still cap this member.
from line 82
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 96
- `scope: object` + Scope selecting a single member of the organization. + - `type: "user"` + Scope type. Always `user` for this scope. + default: user - `user_id: string` + Tagged ID of the member the spend limit applies to. + - `source: object or object or object or 2 more` + Scope selecting a single member of the organization. + - `User object` + Scope selecting a single member of the organization. + - `type: "user"` + Scope type. Always `user` for this scope. + default: user - `user_id: string` + Tagged ID of the member the spend limit applies to. + - `SeatTier object` - `seat_tier: string`
from line 179
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 187
"period_to_date_spend": "12050.5", "scope": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "source": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit_id": "spend_limit_id" }