Skip to main content
POST
Set Limit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id
string
required

The appId field.

Body

application/json

The AppCapServiceSetLimitRequest message.

limit
Spend Limit · object | null

SpendLimit is the three-way behavior fork. Which arms are legal depends on the scope carrying it; pkg/funds enforces that matrix, not the schema, because one SpendControls shape is shared by every scope.

This message contains a oneof named kind. Only a single field of the following list may be set at a time:

  • unlimited
  • amount
  • blocked
period
enum<string>

Optional period override. Only valid together with the limit it denominates.

Available options:
PERIOD_KIND_UNSPECIFIED,
PERIOD_KIND_DAILY,
PERIOD_KIND_WEEKLY,
PERIOD_KIND_MONTHLY,
PERIOD_KIND_QUARTERLY,
PERIOD_KIND_YEARLY

Response

200 - application/json

Successful response

The AppCapServiceSetLimitResponse message.

cap
App Cap · object | null

AppCap is one app's tenant-wide ceiling as the API renders it.