Skip to main content
POST
Pause a subscription

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… for test mode, sk_live_… for live. Server-side only.

Path Parameters

id
string
required

Response

Pause submitted on chain. The object is unchanged until subscription.updated reports paused; pending_tx is the relayer's transaction.

id
string
required
Example:

"sub_7Hq2mV9kLp3RxT"

object
enum<string>
required
Available options:
subscription
status
enum<string>
required
Available options:
incomplete,
active,
paused,
canceled
product
string
required
customer
string
required
checkout_session
string | null
required
manage_url
string
required

Where the subscriber manages all their meters (FR-API-140b). Your app shows this meter with @elapse/react.

Example:

"https://elapse.finance/account"

rate_usd_per_second
string
required
started_at
integer | null
required
paused_at
integer | null
required
paused_seconds
integer
required
canceled_at
integer | null
required
ended_reason
enum<string> | null
required
Available options:
canceled,
cap_reached,
null
max_duration_seconds
integer
required
max_escrow_usd
string
required
funded_usd
string
required
settled_usd
string
required
seconds_elapsed
integer
required
stream_address
string | null
required
chain_id
integer
required
currency
enum<string>
required
Available options:
ausd
livemode
boolean
required
created
integer
required
product_name
string
required
customer_email
string | null
required
pending_tx
string
required