Skip to main content
PATCH
Update Subscription

Update Subscription

Changes the settings of a subscription, pauses or resumes it, or moves it to another address. Send only the fields you want to change; the others stay as they are. Changes apply right away: we check the subscription again after every edit. Requires the buy_bandwidth scope.

Path parameters

number
required
Subscription ID — the id from Create or List Subscriptions

Request body

boolean
false pauses the subscription: we take the bandwidth back and charge nothing until you resume it. true resumes a paused or stopped subscription; your balance must cover 24 hours and one transfer, as when creating. A subscription switched off by support (stopped_reason: "admin") cannot be resumed this way.
number
New bandwidth amount. From 1 to 5,000. Raising it within a paid day charges the difference for the rest of the day.
string
Move the subscription to another address. We take the bandwidth back from the old address, then delegate to the new one; address_change_to shows the move until it is done. The new address goes through the same checks as on create. Sending the current address cancels a move that has not finished.
string
"USDT", "TRX", "USDD", "CUSTOM" or "OWN". Switching to USDT, TRX or USDD removes the contract.
string | null
A contract from your token list, for CUSTOM or OWN. null removes it (not possible with CUSTOM).
string | null
New label, up to 50 characters. null or an empty string removes it.
boolean
Turn auto-pause on or off.
number
New free bandwidth level, with the same range as on create.
boolean
Turn the free bandwidth notification on or off.
boolean
true pauses the subscription after the next transfer of its token, counted from now. false cancels that.

Response

The updated subscription, with the same fields as in List Subscriptions.

Example

Pause a subscription:
Response
delegated_bw drops to 0 once the bandwidth has been taken back, within a few seconds.

Errors