Skip to main content
POST
/
v1
/
subscriptions
/
{id}
/
pause
Python (ticksupply library)
# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
client.subscriptions.pause("sub_019478a23c5f7b8e9d12abcdef012345")
{
  "error": {
    "code": "invalid_argument",
    "message": "Invalid datastream_id: must be a positive integer"
  }
}

Authorizations

​
X-Api-Key
string
header
required

Your API key. Get one from the dashboard at https://app.ticksupply.com/api-keys

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent requests. If you retry a request with the same key, you'll receive the original response without the operation being performed again.

Must be a valid UUID (any version — v4 recommended for uniqueness), up to 128 characters.

Maximum string length: 128

Path Parameters

​
id
string
required

Subscription ID (prefixed format, e.g., sub_xxx)

Pattern: ^sub_[a-f0-9]{32}$

Response

Subscription paused successfully

Last modified on April 18, 2026