Haijun Platform Docs
ID

GET /v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

While pending, the response includes a live spend_summary for the requester at the request's period.

Path parameters

  • spend_limit_increase_request_id: string

ID of the spend limit increase request.

Returns

  • BetaSpendLimitIncreaseRequest object
  • type: "spend_limit_increase_request"

default: spend_limit_increase_request

  • id: string
  • actor: object

A user within the organization. name and email_address are null when the underlying account is unavailable or has been deleted; deleted is true only for deleted accounts.

  • type: "user_actor"

Actor type. Always user_actor.

default: user_actor

  • 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.

  • user_id: string

Tagged ID of the user.

  • created_at: string

format: date-time

  • period: "daily" or "monthly" or "weekly"
  • "daily"
  • "monthly"
  • "weekly"
  • resolved_at: string or null

format: date-time

  • resolved_by: UserActor or ScopedAPIKeyActor or null
  • UserActor object

A user within the organization. name and email_address are null when the underlying account is unavailable or has been deleted; deleted is true only for deleted accounts.

  • type: "user_actor"

Actor type. Always user_actor.

default: user_actor

  • 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.

  • user_id: string

Tagged ID of the user.

  • ScopedAPIKeyActor object

A scoped Admin API key acting on behalf of the organization.

  • type: "scoped_api_key_actor"

default: scoped_api_key_actor

  • scoped_api_key_id: string
  • spend_summary: BetaSpendSummary or null

Per-member effective-limit report row (GET /spend_limits/effective).

  • actor: UserActor or ScopedAPIKeyActor
  • UserActor object

A user within the organization. name and email_address are null when the underlying account is unavailable or has been deleted; deleted is true only for deleted accounts.

  • type: "user_actor"

Actor type. Always user_actor.

default: user_actor

  • 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.

  • user_id: string

Tagged ID of the user.

  • ScopedAPIKeyActor object

A scoped Admin API key acting on behalf of the organization.

  • type: "scoped_api_key_actor"

default: scoped_api_key_actor

  • scoped_api_key_id: string
  • 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.

  • currency: string

ISO 4217 code of the organization's billing currency; the unit for amount and period_to_date_spend.

  • period: "daily" or "monthly" or "weekly"

Period this row's effective limit and spend are reported for.

  • "daily"
  • "monthly"
  • "weekly"
  • period_to_date_spend: string

The member's spend so far in the current period, as a non-negative decimal string in the minor unit of currency (cents for USD). May carry fractional minor units up to three decimal places (e.g. "12050.5") — metered usage is not rounded to whole cents. Reads as "0" when the spend reading is temporarily unavailable.

  • scope: User or SeatTier or RBACGroup or 3 more
  • 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
  • type: "seat_tier"

default: seat_tier

  • seat_tier: string
  • RBACGroup object
  • type: "rbac_group"

default: rbac_group

  • rbac_group_id: string
  • OrganizationService object
  • type: "organization_service"

default: organization_service

  • service: string
  • Organization object
  • type: "organization"

default: organization

  • Workspace object

Scope selecting one workspace of a Haijun Console organization.

  • type: "workspace"

Scope type. Always workspace for this scope.

default: workspace

  • workspace_id: string

Tagged ID of the workspace the spend limit applies to.

  • source: User or SeatTier or RBACGroup or 3 more
  • 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
  • type: "seat_tier"

default: seat_tier

  • seat_tier: string
  • RBACGroup object
  • type: "rbac_group"

default: rbac_group

  • rbac_group_id: string
  • OrganizationService object
  • type: "organization_service"

default: organization_service

  • service: string
  • Organization object
  • type: "organization"

default: organization

  • Workspace object

Scope selecting one workspace of a Haijun Console organization.

  • type: "workspace"

Scope type. Always workspace for this scope.

default: workspace

  • workspace_id: string

Tagged ID of the workspace the spend limit applies to.

  • spend_limit_id: string
  • status: "approved" or "denied" or "pending"
  • "approved"
  • "denied"
  • "pending"

Example

bash
curl https://haijun.my.id/v1/organizations/spend_limit_increase_requests/$SPEND_LIMIT_INCREASE_REQUEST_ID \
    -H 'juglow-version: 2023-06-01' \
    -H "X-Api-Key: $JUGLOW_API_KEY"

Response (200)

json
{
  "id": "id",
  "actor": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "created_at": "2019-12-27T18:11:19.117Z",
  "period": "monthly",
  "resolved_at": "2019-12-27T18:11:19.117Z",
  "resolved_by": {
    "deleted": true,
    "email_address": "email_address",
    "name": "name",
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "spend_summary": {
    "actor": {
      "deleted": true,
      "email_address": "email_address",
      "name": "name",
      "type": "user_actor",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    },
    "amount": "50000",
    "currency": "USD",
    "period": "monthly",
    "period_to_date_spend": "12050.5",
    "scope": {
      "type": "user",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    },
    "source": {
      "type": "user",
      "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
    },
    "spend_limit_id": "spend_limit_id"
  },
  "status": "approved",
  "type": "spend_limit_increase_request"
}
On this page
Path parametersReturnsExampleResponse (200)