Get auto top-up
Read whether the subscription tops up automatically with its saved payment method when its available credits or balance reach a threshold, with the top-ups used this period and the last failure.
2026-08-27. Send Commet-Version: 2026-08-27 with your request.Autorizaciones
Encabezados
API version used by this reference. Send this header to select this contract explicitly.
Parámetros de ruta
Respuesta
Success
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.
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.
-9007199254740991 <= x <= 9007199254740991Credits each top-up buys on a credits plan, or null when never configured or on a balance plan.
-9007199254740991 <= x <= 9007199254740991Minor 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.
-9007199254740991 <= x <= 9007199254740991Maximum top-ups per renewal period, or null when never configured.
-9007199254740991 <= x <= 9007199254740991active 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.
active, paused, off Top-ups made in the current renewal period.
-9007199254740991 <= x <= 9007199254740991When the top-up count of the period resets, or null before the subscription starts its first period.
The last top-up that failed, or null when none has failed.
"subscription_auto_top_up"