Skip to main content
Pause and resume are sender controls for active streams. In the current product, pause is available on streams that were created as cancelable.

​
Supported Families

  • LINEAR
  • STEP
  • HYBRID
  • TRANCHE
  • RECURRING

​
Who Can Pause or Resume

  • only the stream sender
  • only while the stream is in the correct status
    • ACTIVE to pause
    • PAUSED to resume

​
Pause Flow

1

Open the stream

Navigate to the stream detail page as the sender.
2

Build the pause transaction

The app calls POST /api/streams/:id/pause with the sender address in x-user-address.
3

Sign and broadcast

Sign the returned transaction in the wallet.
4

Confirm the broadcast

The app calls POST /api/streams/:id/confirm-pause with the transaction hash. The stream status changes to PAUSED.

​
Resume Flow

1

Build the resume transaction

Click Resume on a paused stream. The app calls POST /api/streams/:id/resume.
2

Sign and broadcast

Sign the returned wallet transaction.
3

Confirm the broadcast

The app calls POST /api/streams/:id/confirm-resume. The stream returns to ACTIVE.

​
What Pause Means

  • vesting-based schedules stop progressing while paused
  • recurring schedules stop accruing new payment windows while paused
  • no value is paid out by the pause transaction itself

​
API Example

POST /api/streams/:id/pause
x-user-address: bchtest:qsender...

POST /api/streams/:id/confirm-pause
x-user-address: bchtest:qsender...

{
  "txHash": "hex64"
}