Saltar al contenido principal
GET
Get auto top-up
This reference describes API version 2026-08-27. Send Commet-Version: 2026-08-27 with your request.

Autorizaciones

x-api-key
string
header
requerido

Encabezados

Commet-Version
string
predeterminado:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Parámetros de ruta

id
string
requerido

Respuesta

Success

enabled
boolean
requerido

Whether top-ups run automatically: credits bought on a credits plan, balance added on a balance plan. Always false when the plan does not sell credits or has balance top-ups turned off.

threshold
integer | null
requerido

The available amount at or below which a top-up runs, or null when never configured: credits (plan plus purchased) on a credits plan, minor units of the subscription currency (plan plus purchased balance) on a balance plan.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
quantity
integer | null
requerido

Credits each top-up buys on a credits plan, or null when never configured or on a balance plan.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
amount
integer | null
requerido

Minor units of the subscription currency each top-up adds on a balance plan, charged plus tax, or null when never configured or on a credits plan.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
maxPerPeriod
integer | null
requerido

Maximum top-ups per renewal period, or null when never configured.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
requerido

active tops up when the available amount reaches the threshold; paused stops after three consecutive failed top-ups, or after one whose charge could not be refunded, until the payment method changes, a credit purchase or balance top-up succeeds or it is saved enabled again; off tops up nothing.

Opciones disponibles:
active,
paused,
off
topUpsThisPeriod
integer
requerido

Top-ups made in the current renewal period.

Rango requerido: -9007199254740991 <= x <= 9007199254740991
periodResetsAt
string<date-time> | null
requerido

When the top-up count of the period resets, or null before the subscription starts its first period.

lastFailure
object | null
requerido

The last top-up that failed, or null when none has failed.

object
string
requerido
Allowed value: "subscription_auto_top_up"
livemode
boolean
requerido