Rivier/ Reference/ usage

Set an allowance

put/usage/allocations

Before you call

Credential
Authorization: Bearer $KEY
Scope
usage:admin
Graphql
Mutation.usageAllocationSet
Sdk
usage.allocation.set
Cli
usage allocation set

Request bodyapplication/json, required

  • meterstringrequired
    At most 60 characters.
  • scopeKindstringrequired
    One of: product, agent, interest, channel.
  • scopeIdstringrequired
    At most 100 characters.
  • limitintegerrequired
    At least 0.

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown