budgets.createBudget

POST

/v1/organization/budgets

const url = 'https://example.com/v1/organization/budgets';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"scope":"organization","scopeId":"example","period":"day","limitMicros":1,"mode":"hard"}'
};

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

curl --request POST \
  --url https://example.com/v1/organization/budgets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scope": "organization", "scopeId": "example", "period": "day", "limitMicros": 1, "mode": "hard" }'

Adds a budget. Each scope can have one budget for each period.

Authorizations

token
session

Request Body^required

application/json

object

scope

required

string

Allowed values: organization member bot token

scopeId

string

>= 1 characters <= 200 characters

period

required

string

Allowed values: day month

limitMicros

required

integer

<= 9007199254740991

mode

required

string

Allowed values: hard soft

Responses

201

Success

application/json

object

required

string

>= 1 characters <= 128 characters

scope

required

string

Allowed values: organization member bot token

scopeId

required

string

period

required

string

Allowed values: day month

limitMicros

required

integer

<= 9007199254740991

mode

required

string

Allowed values: hard soft

periodStart

required

string

spentMicros

required

integer

<= 9007199254740991

exceeded

required

boolean

version

required

integer

<= 9007199254740991

createdAt

required

string

updatedAt

required

string

Example

{
  "scope": "organization",
  "period": "day",
  "mode": "hard"
}

400

UsageQueryInvalid | BudgetInvalid | OrganizationRequired

application/json

Any of:

object

_tag

required

string

Allowed values: UsageQueryInvalid

message

required

string

Example

{
  "_tag": "UsageQueryInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

BudgetNotFound

application/json

object

_tag

required

string

Allowed values: BudgetNotFound

budgetId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "BudgetNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending | BudgetConflict

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

BillingUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PolicyUnavailable

Example

{
  "_tag": "PolicyUnavailable"
}

budgets.createBudget

Authorizations

Request Bodyrequired

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

503

Example

Request Body^required