Limit routes: update, delete

Reference for Limit, one group of Limit routes.

Limit.update

Changes the given properties of a Limit. Verb page.

Text

PATCH /{namespace}/limits/{id}

Path: id. Body, as JSON: the other inputs. Emits Limit.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Limit.
`amount`	`money`		The most money it allows.
`count`	`integer`		The most calls or units it allows.
`period`	`string`		The window a rate resets over, such as a month.
`percent`	`number`		The largest share off a reference amount it allows, such as 15 percent off list Price.
`resets`	`string`		One of `calendar`, `rolling`: a calendar Limit resets at the start of each period, a rolling one counts the last period from now.

Returns

Output	Type	Required	Description
`limit`	Limit	required	The Limit.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/limits/limit_UWHXYVKsJB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":29,"currency":"USD"}}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "limit": {
    "$id": "https://api.sb/leaseline.app/limits/limit_UWHXYVKsJB",
    "$type": "Limit",
    "amount": {
      "amount": 29,
      "currency": "USD"
    },
    "count": 1
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Limit.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Limit.delete

Deletes a Limit: a soft delete that keeps its history, undone by Thing.restore. Verb page.