Get Auto Top-up Settings
/v1/billing/auto-top-upParameters
workspace_idquery · stringRequiredResponses
200Current automatic top-up policy and payment method summary.
availablebooleanRequiredenabledbooleanRequiredcurrencystringRequiredcustomer_idstring | nullRequiredthresholdnumberRequiredMinimum 0
amountnumberRequiredMinimum 0
payment_methodobject | nullRequiredShow nested fields
Option 1: object
typestringRequiredbrandstring | nullRequiredlast4string | nullRequiredexp_monthinteger | nullRequiredMinimum 1 · Maximum 12
exp_yearinteger | nullRequiredOption 2: null
null
last_statusstring | nullRequiredValues: "pending""open""processing""paid""failed""expired"null
last_errorstring | nullRequiredlast_charged_atstring | nullRequired401Authentication is missing or invalid.
errorobjectRequiredShow nested fields
codestringRequiredmessagestringRequiredparamstring | nullrequest_idstring | nullmetadataobjectTyped detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.
403Authenticated principal lacks permission.
errorobjectRequiredShow nested fields
codestringRequiredmessagestringRequiredparamstring | nullrequest_idstring | nullmetadataobjectTyped detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.
500Internal server error.
errorobjectRequiredShow nested fields
codestringRequiredmessagestringRequiredparamstring | nullrequest_idstring | nullmetadataobjectTyped detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.