Skip to navigation

Update Additional Usage Settings

View as Markdown

Turn metered usage past the monthly allowances on or off and choose how it is paid. Free accounts can enable PREPAID_CREDIT; USAGE_INVOICE requires an active AI Plus or AI Pro subscription. Send {“enabled”:false} to stop recording it. Returns the settings with this UTC month’s priced usage.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
enabledboolean or nullOptional
Turn recording of usage past the monthly caps on or off.
fundingenum or nullOptional

PREPAID_CREDIT spends purchased credit packs and stops when they run out. USAGE_INVOICE bills an invoice each time unbilled usage reaches invoiceIncrementCents, up to spendCapCents per month.

Allowed values:
invoiceIncrementCentslong or nullOptional

Unbilled cents that trigger a USAGE_INVOICE invoice; one of the plan catalog’s invoiceIncrementCents.

spendCapCentslong or nullOptional

Monthly spend cap in cents; required for USAGE_INVOICE.

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
availableCreditCentsdouble

Spendable prepaid credit after pending usage and invoice-line rounding reserves, in cents.

blockedboolean

True while a failed threshold invoice blocks additional usage; paying it in Billing Portal clears the block.

enabledboolean
Whether usage past the monthly caps is recorded and billed.
meterlist of objects
resetAtdatetime

When spentCents returns to zero: the next UTC month.

spentCentsdouble
Additional usage priced this UTC month, in cents.
unbilledCentsdouble

Priced usage not yet paid by credit or placed on an invoice, in cents; the next threshold or period invoice bills it.

fundingenum or nullOptional

PREPAID_CREDIT spends purchased credit packs and stops when they run out. USAGE_INVOICE bills an invoice each time unbilled usage reaches invoiceIncrementCents, up to spendCapCents per month.

Allowed values:
invoiceIncrementCentslong or nullOptional

USAGE_INVOICE bills an invoice once unbilled usage reaches this many cents; the invoice can exceed it by the usage recorded while it was being created.

spendCapCentslong or nullOptional

Monthly spend cap in cents. Required for USAGE_INVOICE; absent for PREPAID_CREDIT means only the prepaid credit bounds usage.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error