Skip to main content
GET
/
user
/
preferences
Get user preferences
curl --request GET \
  --url https://api.example.com/user/preferences \
  --header 'Authorization: Bearer <token>'
{
  "notify_email_cluster_create": true,
  "notify_email_cluster_destroy": true,
  "autopay_enabled": true,
  "balance_warning_threshold": 123,
  "autopay_reload_threshold": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Response model for GET /user/preferences endpoint.

​
notify_email_cluster_create
boolean
required

Whether to send email notifications when clusters are created

​
notify_email_cluster_destroy
boolean
required

Whether to send email notifications when clusters are destroyed

​
autopay_enabled
boolean
required

Whether autopay is enabled. When enabled, TensorPool automatically charges your saved payment method when your balance falls below autopay_reload_threshold.

Requirements to enable:

  • Must have a default payment method saved (add at /dashboard/balance)
  • Must set autopay_reload_threshold

How it works:

  • When balance drops below autopay_reload_threshold, automatically charges saved payment method
  • Requires saved payment method on file
  • Can be disabled at any time
​
balance_warning_threshold
number | null

Balance threshold (in USD) at which to send warning email notifications. Must be positive if set. Should be higher than autopay_reload_threshold if both are set.

​
autopay_reload_threshold
number | null

Balance threshold (in USD) at which autopay automatically reloads balance. Must be at least $20 and less than balance_warning_threshold if both are set.