Skip to main content
POST
Reclaim Order

Reclaim Order

Undelegates the bandwidth of your order right away — for example, once the address has made the transfer it was rented for — instead of waiting for the end of the term. The unused time is not refunded. Only bandwidth orders can be reclaimed early.

Path parameters

number
required
Order ID — the id returned by Buy Bandwidth.

Response

Returns the order object, the same as Get Order. status tells what happened: A repeated call for an order that is already reclaiming, reclaimed or reclaim_failed returns the order unchanged, so retries are safe. The API key needs the buy_bandwidth scope.

Errors

Example

Response