Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Core grammar

Limit

A Limit is a bound on a Permission, Entitlement, or Mandate, checked before every call; exceeding it creates an Approval.

Properties

PropertyTypeRequiredDescription
amountmoneyThe most money it allows.
countintegerThe most calls or units it allows.
periodstringThe window a rate resets over, such as a month.
percentnumberThe largest share off a reference amount it allows, such as 15 percent off list Price.
resetsstringOne of calendar, rolling: a calendar Limit resets at the start of each period, a rolling one counts the last period from now.

Object

JSON
{
  "$id": "https://api.sb/routewise.dev/limits/limit_1",
  "$type": "Limit",
  "amount": {
    "amount": 25,
    "currency": "USD"
  },
  "count": 1,
  "period": "Example period",
  "percent": 1,
  "resets": "calendar"
}

Relationships

None.

Verbs

  1. createCreates a Limit.
    POST /{namespace}/limitsdoLimit.created
  2. getReturns one Limit by id.
    GET /{namespace}/limits/{id}readNo Event
  3. listReturns Limits, newest first, one page at a time.
    GET /{namespace}/limitsreadNo Event
  4. updateChanges the given properties of a Limit.
    PATCH /{namespace}/limits/{id}doLimit.updated
  5. deleteDeletes a Limit; its history is kept.
    DELETE /{namespace}/limits/{id}doLimit.deleted
  6. raiseRaise lifts a Limit after an Approval allows it, and the Action that waited on it proceeds.
    POST /{namespace}/limits/{limit}/raisedoLimit.raised

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Limit.createYesYesNoNo
Limit.getYesYesYesYes
Limit.listYesYesYesYes
Limit.updateYesYesNoNo
Limit.deleteYesYesNoNo
Limit.raiseYesNoNoNo

Call it

Text
Raise the latest limit.

Example

The Billing Specialist's refund Limit is $100. A $250 refund stops before it runs and opens an Approval.

Lifecycle.update

Previous Page

Limit.create

Next Page