One change
Spend Limits
api/admin/spend_limits
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 Changed · +369 / -33 lines
The two sides of this change are too far apart to line up, so this is the differ's own diff of it.
from line 18
- `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. + - `period: optional "daily" or "monthly" or "weekly"` - `"daily"`
from line 42
- `SpendLimit object` + A configured spend limit: a cap on metered spend for one scope and period. + - `id: string` + Unique tagged ID of the spend limit (`spl_...`). + - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` + RFC 3339 datetime at which the spend limit was created. + format: date-time - `currency: string`
from line 64
- `period: "daily" or "monthly" or "weekly"` + Length of the window the limit resets over. `amount` caps spend within each period. + - `"daily"` - `"monthly"`
from line 74
- `scope: object or object or object or 2 more` + What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. + - `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 122
- `type: "spend_limit"` + Object type. Always `spend_limit`. + default: spend_limit - `updated_at: string` + + RFC 3339 datetime at which the spend limit was last modified. format: date-time
from line 143
"amount": "50000", "scope": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "period": "monthly" }'
from line 160
"period": "monthly", "scope": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z"
from line 183
- `SpendLimit object` + A configured spend limit: a cap on metered spend for one scope and period. + - `id: string` + Unique tagged ID of the spend limit (`spl_...`). + - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` + RFC 3339 datetime at which the spend limit was created. + format: date-time - `currency: string`
from line 205
- `period: "daily" or "monthly" or "weekly"` + Length of the window the limit resets over. `amount` caps spend within each period. + - `"daily"` - `"monthly"`
from line 215
- `scope: object or object or object or 2 more` + What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. + - `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 263
- `type: "spend_limit"` + Object type. Always `spend_limit`. + default: spend_limit - `updated_at: string` + + RFC 3339 datetime at which the spend limit was last modified. format: date-time
from line 292
"period": "monthly", "scope": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z"
from line 355
- `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
from line 393
- `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 425
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 439
- `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`
from line 522
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 530
"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" }
from line 549
- `SpendLimit object` + A configured spend limit: a cap on metered spend for one scope and period. + - `id: string` + Unique tagged ID of the spend limit (`spl_...`). + - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` + RFC 3339 datetime at which the spend limit was created. + format: date-time - `currency: string`
from line 571
- `period: "daily" or "monthly" or "weekly"` + Length of the window the limit resets over. `amount` caps spend within each period. + - `"daily"` - `"monthly"`
from line 581
- `scope: object or object or object or 2 more` + What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. + - `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 629
- `type: "spend_limit"` + Object type. Always `spend_limit`. + default: spend_limit - `updated_at: string` + RFC 3339 datetime at which the spend limit was last modified. + format: date-time ### Spend Summary - `SpendSummary object` - Per-member effective-limit report row (GET /spend_limits/effective). + Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: object`
from line 653
- `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 685
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 699
- `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`
from line 820
- `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. - `created_at: string`
from line 872
- `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. + - `ScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization.
from line 906
- `spend_summary: SpendSummary or null` - Per-member effective-limit report row (GET /spend_limits/effective). + Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: object`
from line 916
- `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 948
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 962
- `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`
from line 1058
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly",
from line 1068
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": {
from line 1076
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 1084
"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" },
from line 1129
- `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. - `created_at: string`
from line 1181
- `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. + - `ScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization.
from line 1215
- `spend_summary: SpendSummary or null` - Per-member effective-limit report row (GET /spend_limits/effective). + Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: object`
from line 1225
- `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 1257
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 1271
- `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`
from line 1363
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly",
from line 1373
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": {
from line 1381
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 1389
"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" },
from line 1447
- `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. - `created_at: string`
from line 1499
- `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. + - `ScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization.
from line 1533
- `spend_limit: SpendLimit` + A configured spend limit: a cap on metered spend for one scope and period. + - `id: string` + Unique tagged ID of the spend limit (`spl_...`). + - `amount: string or null` Limit amount as a non-negative integer decimal string in the minor unit of `currency` (cents for USD): "50000" is $500.00. `null` means no numeric cap is configured at this scope — see the effective report for whether a limit applies. - `created_at: string` + RFC 3339 datetime at which the spend limit was created. + format: date-time - `currency: string`
from line 1555
- `period: "daily" or "monthly" or "weekly"` + Length of the window the limit resets over. `amount` caps spend within each period. + - `"daily"` - `"monthly"`
from line 1565
- `scope: object or object or object or 2 more` + What the limit applies to. A tagged union on `type`; each variant carries the identifier for its scope. + - `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 1613
- `type: "spend_limit"` + Object type. Always `spend_limit`. + default: spend_limit - `updated_at: string` + RFC 3339 datetime at which the spend limit was last modified. + format: date-time - `spend_summary: SpendSummary or null` - Per-member effective-limit report row (GET /spend_limits/effective). + Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: object`
from line 1635
- `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 1667
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 1681
- `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`
from line 1778
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly",
from line 1788
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_limit": { "id": "id",
from line 1798
"period": "monthly", "scope": { "type": "user", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "type": "spend_limit", "updated_at": "2019-12-27T18:11:19.117Z"
from line 1809
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 1817
"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" },
from line 1863
- `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. - `created_at: string`
from line 1915
- `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. + - `ScopedAPIKeyActor object` A scoped Admin API key acting on behalf of the organization.
from line 1949
- `spend_summary: SpendSummary or null` - Per-member effective-limit report row (GET /spend_limits/effective). + Per-member effective-limit report row (`GET /spend_limits/effective`). - `actor: object`
from line 1959
- `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 1991
- `period: "daily" or "monthly" or "weekly"` + Period this row's effective limit and spend are reported for. + - `"daily"` - `"monthly"`
from line 2005
- `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`
from line 2099
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "created_at": "2019-12-27T18:11:19.117Z", "period": "monthly",
from line 2109
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "spend_summary": { "actor": {
from line 2117
"email_address": "email_address", "name": "name", "type": "user_actor", - "user_id": "user_id" + "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q" }, "amount": "50000", "currency": "USD",
from line 2125
"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" },