Skip to main content
GET
Get subscription

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1

Path Parameters

id
string<uuid>
required

Subscription ID

Response

Success

address
string

The monitored on-chain address.

Example:

"0x742d35Cc6634C0532925a3b844Bc454e4438f44e"

chain
string

Blockchain the address is on.

Example:

"ethereum"

created_at
string<date-time>

ISO-8601 time when the subscription was created.

Example:

"2026-05-16T10:30:00Z"

event_type
string

Event-type filter; empty means all on-chain event types.

Example:

"incoming_token_tx"

failure_reason
string

Reason the subscription failed; populated only when status is "failed".

has_signing_secret
boolean

Whether a signing secret is configured for delivery verification.

Example:

true

id
string

Unique identifier of the subscription.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

label
string

Optional partner-facing label.

Example:

"Customer deposit monitor"

last_event_at
string<date-time>

ISO-8601 time of the most recent delivered event.

metadata
object

Arbitrary partner-supplied key/value metadata.

network
string

Network the address is on.

Example:

"mainnet"

object
string

Object type discriminator; always "subscription".

Example:

"subscription"

signing_secret
string

Plaintext HMAC signing secret. Returned ONLY on create and rotate-secret — never on GET/list.

status
string

Current status of the subscription.

Example:

"active"

updated_at
string<date-time>

ISO-8601 time when the subscription was last updated.

Example:

"2026-05-16T10:30:00Z"

webhook_url
string

URL on-chain events are delivered to.

Example:

"https://example.com/webhooks/bitnob"