pauseStream

Pauses an active stream

Important:

If a stream is paused, any pending lamports will still be transferred if the amount of pending lamports is greater than the threshold. If the amount of pending lamports is below the threshold, no lamports will be transferred. However, if the balance of the Stream Wallet is not healthy, the user will still be prompted to refill the Stream Wallet. To disable these prompts and forfeit the pending lamports, please use the closeStream method instead.

(async() => {
    let paused = await SOLPay.pauseStream("..."); // true
})();

Parameters:

• stream: string - the stream to pause

Returns:

boolean (true) - the confirmation for pausing a stream

Throws:

• SOL Pay SDK Fatal Error: Invalid stream ${stream}. - an invalid stream was used