Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Headers

Idempotency-Key
string

Optional. A request that finished, with a success or a refusal, answers a retry with its first answer and idempotentReplay: true, and nothing runs again. Once the cause of a refusal is fixed, try again with a new key. After a 5xx the same key runs the request again.

Required string length: 8 - 255

Body

application/json

The setting.

enabled
boolean
required

On or off.

planCode
enum<string>

The plan it buys. Leave out to keep the current one. A plan your price list does not include answers PLAN_NOT_FOUND; BRONZE is on self-serve price lists only.

Available options:
BRONZE,
SILVER,
GOLD,
DIAMOND
thresholdMinutes
integer

Buy when the balance falls to this many minutes. Only for an agency our team manages.

Required range: 10 <= x <= 200

Response

The auto-recharge setting as it now stands.

success
boolean
required
Example:

true

data
object
required
idempotentReplay
boolean

Present, and true, when this answer is a replay of an earlier request with the same Idempotency-Key.