COconductorone
Spend Insights

Resolve Effective Limits

Changed on

Resolve the budget limits and current usage that apply to a user. Optionally includes application-specific limits.

get/api/v1/spend-insights/effective-limits/{user_id}

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/spend-insights/effective-limits/{user_id}
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

user_idstring required

User whose effective limits should be resolved.

Query parameters

app_idstring

Optional application used to include application-specific limits.

Response

ResolveEffectiveLimitsResponse contains the limits currently applying to a user.

currencyCodestring

Currency used for monetary values.

denialReason'SPEND_DENY_REASON_UNSPECIFIED' | 'SPEND_DENY_REASON_TENANT_FROZEN' | 'SPEND_DENY_REASON_SUSPENDED_BY_ADMIN' | 'SPEND_DENY_REASON_APP_SUSPENDED' | 'SPEND_DENY_REASON_APP_PAUSED_BY_YOU' | 'SPEND_DENY_REASON_NO_SUPPLY'

Reason spend is denied. Present only when state is DENIED.

denialScopeNamestring

Scope that denies spend. Present only when state is DENIED.

state'EFFECTIVE_LIMITS_STATE_UNSPECIFIED' | 'EFFECTIVE_LIMITS_STATE_RESOLVED' | 'EFFECTIVE_LIMITS_STATE_NO_POLICY' | 'EFFECTIVE_LIMITS_STATE_NO_CEILING' | 'EFFECTIVE_LIMITS_STATE_DENIED'

Result of resolving the user's effective limits.

Changes

  • fe943bedf41bRevision changes
    • breaking

      added to the // response property oneOf list for the response status

    • breaking

      added to the // response property oneOf list for the response status

    • warning

      added the new SPEND_DENY_REASON_APP_PAUSED_BY_YOU enum value to the response property for the response status

    • warning

      added the new SPEND_DENY_REASON_APP_SUSPENDED enum value to the response property for the response status

    • warning

      added the new SPEND_DENY_REASON_NO_SUPPLY enum value to the response property for the response status

    • warning

      added the new SPEND_DENY_REASON_SUSPENDED_BY_ADMIN enum value to the response property for the response status

    • warning

      added the new SPEND_DENY_REASON_TENANT_FROZEN enum value to the response property for the response status

    • warning

      added the new SPEND_DENY_REASON_UNSPECIFIED enum value to the response property for the response status

    • info

      removed the DENY_REASON_APP_PAUSED_BY_YOU enum value from the response property for the response status

    • info

      removed the DENY_REASON_APP_SUSPENDED enum value from the response property for the response status

    • info

      removed the DENY_REASON_NO_SUPPLY enum value from the response property for the response status

    • info

      removed the DENY_REASON_SUSPENDED_BY_ADMIN enum value from the response property for the response status

    • info

      removed the DENY_REASON_TENANT_FROZEN enum value from the response property for the response status

    • info

      removed the DENY_REASON_UNSPECIFIED enum value from the response property for the response status

    • info

      removed from the // response property oneOf list for the response status

    • info

      removed from the // response property oneOf list for the response status

  • 918a4e749f56Revision changes
    • info

      endpoint added