Skip to main content
POST
Create Subscription

Create Subscription

Creates an Auto Bandwidth subscription for one address. From the next check on — usually within seconds — we keep volume bandwidth delegated to the address and renew it after each transfer that uses it up. See the overview for how renewal, cost and statuses work. The request itself charges nothing, but your balance must cover the first 24 hours and one transfer — plus activation, if the address does not exist on-chain yet — or it returns 402 INSUFFICIENT_BALANCE. Requires the buy_bandwidth scope. To see the price first, use Auto Bandwidth Quote.

Request body

string
required
TRON address to keep bandwidth on — the address that sends the transfers (T… format, 34 characters). Contract addresses are rejected.
number
default:"350"
Bandwidth to keep on the address. From 1 to 5,000. One USDT or USDD transfer takes about 345, a TRX transfer about 270.
string
default:"USDT"
The token the address sends: "USDT", "TRX", "USDD", "CUSTOM" or "OWN". It does not limit which transfers are covered — see Token.
string
Address of a TRC-20 contract from your token list. Required with token: "CUSTOM", optional with "OWN", not accepted with the other tokens.
string
Your own name for the subscription, up to 50 characters. Optional.
boolean
default:"false"
Hold no bandwidth while the address has at least threshold free bandwidth.
number
default:"600"
Free bandwidth level for auto_pause and notify_free_bw. From 1 to 600; when either option is on, it must be between the larger of volume and 345, and 600. Without auto_pause, a volume above 600 allows 600.
boolean
default:"false"
Send a Telegram and email message each time the address’s free bandwidth recovers to threshold.
boolean
default:"false"
Pause the subscription after the next transfer of its token.

Response

The new subscription, with the same fields as in List Subscriptions. Right after creation delegated_bw is 0 and paid_until is null: the first delegation follows within seconds.

Example

Response

Errors

Retrying a create after a timeout is safe. If the first request went through, the retry returns 409 AUTO_BW_ADDRESS_TAKEN instead of making a second subscription; list your subscriptions to get its id.