Update automatic top-up settings

Turns automatic recharging on or off and sets its thresholds. floor_cents must be below recharge_amount_cents, both must fall inside limits, and enabling it requires a usable payment method — each of those fails with its own error.type rather than a generic validation error.

Supply idempotency_attempt if you might retry, so a repeat does not charge twice.

Writes are guarded by expected_digest: send the configuration_digest from your last read, and if someone changed the setting in between you get a 409 whose error.current_state is the configuration as it now stands. Re-read, show the user what changed, and resubmit.

PATCH

api

accounts

{account_id}

billing

auto_top_up

Update automatic top-up settings

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "enabled": true,
  "floor_cents": 1500,
  "recharge_amount_cents": 5000,
  "expected_digest": "EXAMPLE"
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up"

payload = {
    "enabled": True,
    "floor_cents": 1500,
    "recharge_amount_cents": 5000,
    "expected_digest": "EXAMPLE"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    floor_cents: 1500,
    recharge_amount_cents: 5000,
    expected_digest: 'EXAMPLE'
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"floor_cents\": 1500,\n  \"recharge_amount_cents\": 5000,\n  \"expected_digest\": \"EXAMPLE\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"floor_cents\": 1500,\n  \"recharge_amount_cents\": 5000,\n  \"expected_digest\": \"EXAMPLE\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "configuration": {
    "enabled": true,
    "floor_cents": 1000,
    "recharge_amount_cents": 5000
  },
  "freshness": {
    "source": "billing_provider",
    "as_of": "2026-09-21T04:25:03Z",
    "state": "fresh"
  },
  "eligibility": {
    "eligible": true,
    "payment_method_ready": true,
    "reason": null
  },
  "dunning_state": null,
  "pending": false,
  "limits": {
    "floor": {
      "min_cents": 100,
      "max_cents": 100000
    },
    "recharge": {
      "min_cents": 500,
      "max_cents": 1000000
    }
  },
  "error": null,
  "configuration_digest": "EXAMPLE"
}

{
  "error": "Resource could not be found"
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

integer

required

The numeric ID of the account

Body

application/json

enabled

boolean

required

Whether to recharge automatically.

floor_cents

integer

required

Balance at which a recharge triggers. Must be below recharge_amount_cents.

Example:

1000

recharge_amount_cents

integer

required

How much to charge each time.

Example:

5000

expected_digest

string

required

The configuration_digest from your last read.

idempotency_attempt

string

Optional client-supplied key so a retried request does not charge twice.

Response

Success

The shape every billing control returns: the current values, where they were read from, whether the account may change them, and the digest that guards the next write.

configuration

object

The current settings.

freshness

object

Where this answer came from and how current it is. Billing reads several systems, so every response says which one it used — treat state other than fresh as a reason to be careful with the numbers rather than a failure.

Show child attributes

eligibility

object

Whether this account can use the control, and why not when it cannot.

dunning_state

string | null

Set when the account is in collections, which restricts some controls.

pending

boolean

True while a previous change is still being applied at the provider.

limits

object

Accepted bounds for each amount, where the control has them.

error

object | null

Set when the control could be read but something is wrong with it.

configuration_digest

string

Fingerprint of the current configuration. Send it back as expected_digest when you write, and a 409 means someone changed it first.

Update automatic top-up settings

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "enabled": true,
  "floor_cents": 1500,
  "recharge_amount_cents": 5000,
  "expected_digest": "EXAMPLE"
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up"

payload = {
    "enabled": True,
    "floor_cents": 1500,
    "recharge_amount_cents": 5000,
    "expected_digest": "EXAMPLE"
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    enabled: true,
    floor_cents: 1500,
    recharge_amount_cents: 5000,
    expected_digest: 'EXAMPLE'
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true,\n  \"floor_cents\": 1500,\n  \"recharge_amount_cents\": 5000,\n  \"expected_digest\": \"EXAMPLE\"\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/billing/auto_top_up"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"floor_cents\": 1500,\n  \"recharge_amount_cents\": 5000,\n  \"expected_digest\": \"EXAMPLE\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "configuration": {
    "enabled": true,
    "floor_cents": 1000,
    "recharge_amount_cents": 5000
  },
  "freshness": {
    "source": "billing_provider",
    "as_of": "2026-09-21T04:25:03Z",
    "state": "fresh"
  },
  "eligibility": {
    "eligible": true,
    "payment_method_ready": true,
    "reason": null
  },
  "dunning_state": null,
  "pending": false,
  "limits": {
    "floor": {
      "min_cents": 100,
      "max_cents": 100000
    },
    "recharge": {
      "min_cents": 500,
      "max_cents": 1000000
    }
  },
  "error": null,
  "configuration_digest": "EXAMPLE"
}

{
  "error": "Resource could not be found"
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

{
  "error": {
    "type": "<string>",
    "message": "<string>",
    "retryable": true,
    "field": "<string>",
    "reason": "<string>",
    "current_state": {}
  }
}

Getting started

Conversations

Contacts

Inboxes and channels

Automation and routing

Reporting

Help Center

Account and access

Billing

Client API

Widget API

Receiving webhooks

Update automatic top-up settings

Authorizations

Path Parameters

Body

Response