Allow an API key to buy credits, with optional limits no higher than the account

put/v1/account/billing/keys/{keyId}/purchase-grant

Request

  • Base URL: https://api.roveapi.com
  • URL: https://api.roveapi.com/v1/account/billing/keys/{keyId}/purchase-grant
  • Auth: API key in cookie rove_session

Path parameters

keyIdstring uuid required

Request body

per_purchase_max_centsinteger nullable

Omitted or null inherits the account limit; never above it.

period_max_centsinteger nullable

Omitted or null inherits the account limit; never above it.

Response

Successful response (Cache-Control: no-store)

api_key_idstring uuid required
key_namestring nullable required
token_prefix'rvp_live_' | 'rvp_test_' required
state'none' | 'granted' | 'revoked' required

none: this key was never allowed to buy.

per_purchase_max_centsinteger nullable required

null inherits the account limit.

period_max_centsinteger nullable required

null inherits the account limit.

period_committed_centsinteger required

This key's purchases this period, in the key's own mode (test keys count test-mode spend).

Changes

No recorded changes to this operation across all 1 revision of this API.