Skip to main content
POST
Setup drawdown billing

Authorizations

Authorization
string
header
required

Rye API key

Body

application/json

Drawdown settings to configure

minBalanceSubunits
integer<int32>
required

Minimum balance threshold in smallest currency unit (e.g. cents). A top-up is triggered when balance falls below this value.

Required range: x >= 10
Example:

200000

targetBalanceSubunits
integer<int32>
required

Target balance in smallest currency unit (e.g. cents). When balance drops below minBalanceSubunits, a top-up invoice is created to replenish to this amount.

Required range: x >= 100
Example:

1000000

chargeAutomatically
boolean

Whether to automatically charge the invoice when created. Defaults to true if not specified.

Example:

true

Response

Updated billing configuration

drawdown
object
required