Sign in
organizations

Changed on

Return the current auto top-up configuration for the org.

get/v1/organizations/billing/auto-top-up/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

enabledboolean required
threshold_usdstring nullable required
amount_usdstring nullable required
monthly_cap_usdstring nullable required
has_payment_methodboolean required
payment_method_brandstring nullable required
payment_method_last4string nullable required
payment_method_exp_monthinteger nullable required
payment_method_exp_yearinteger nullable required
stripe_payment_method_updated_atstring date-time nullable required
last_charge_atstring date-time nullable required
last_failure_atstring date-time nullable required
last_failure_reasonstring nullable required
paused_untilstring date-time nullable required
current_month_credits_purchased_usdstring required
current_month_charged_usdstring required
next_trigger_amount_usdstring nullable required
disabled_due_to_repeated_failuresboolean required
stubbedboolean required

Changes

  • 30e1ff4e89adRevision changes
    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status