Change the organization's budget or the default per member

PATCH

/org/quotas

const url = 'https://api.asklucy.eu/v1/org/quotas';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"default_member_limits":{"five_hours":{"amount":"50.00","currency":"EUR"},"week":{"amount":"50.00","currency":"EUR"},"month":{"amount":"50.00","currency":"EUR"}},"admin_monthly_budget":{"amount":"50.00","currency":"EUR"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.asklucy.eu/v1/org/quotas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "default_member_limits": { "five_hours": { "amount": "50.00", "currency": "EUR" }, "week": { "amount": "50.00", "currency": "EUR" }, "month": { "amount": "50.00", "currency": "EUR" } }, "admin_monthly_budget": { "amount": "50.00", "currency": "EUR" } }'

Either or both. admin_monthly_budget is what the whole organization may spend per month (null: no budget of its own); it can’t be more than the contract’s (contract_monthly_budget).

Authorizations

zitadel

Request Body^required

application/json

A field left out stays as it is.

object

>= 1 properties

default_member_limits

A limit per window; a missing or null window sets no limit at this level.

object

five_hours

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

week

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

month

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

admin_monthly_budget

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

Responses

200

application/json

object

org_monthly_budget

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

admin_monthly_budget

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

contract_monthly_budget

required

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

org_spent_this_month

required

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

month_resets_at

required

string format: date-time

default_member_limits

required

A limit per window; a missing or null window sets no limit at this level.

object

five_hours

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

week

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

month

One of:

object
null

object

amount

required

Decimal amount, e.g. “12.50” (up to 6 decimals for small usage).

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

currency

required

string

Allowed values: EUR

Example

{
  "org_monthly_budget": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "admin_monthly_budget": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "contract_monthly_budget": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "org_spent_this_month": {
    "amount": "50.00",
    "currency": "EUR"
  },
  "default_member_limits": {
    "five_hours": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "week": {
      "amount": "50.00",
      "currency": "EUR"
    },
    "month": {
      "amount": "50.00",
      "currency": "EUR"
    }
  }
}

400

The request is invalid; errors lists what’s wrong.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

401

Missing, expired or invalid token.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

403

The token is valid but lacks the role this needs.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

Change the organization's budget or the default per member

Authorizations

Request Bodyrequired

Responses

200

Example

400

Example

Headers

401

Example

Headers

403

Example

Headers

Request Body^required