View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`SubscriptionScope`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Defines the organizational scope at which a notification subscription operates. Determines which events the subscription can match against based on the reseller/merchant hierarchy.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Merchant`	Subscription scoped to a specific merchant. Only matches events originating from that merchant.
`Reseller`	Subscription scoped to a reseller and all its descendants (sub-resellers and merchants). Uses ResellerPathPrefix for efficient hierarchy matching.
`Admin`	Subscription with tenant-wide scope. Matches events across all resellers and merchants within the tenant. Requires admin-level permissions.

Fields

Field	Type	Description

This model has no documented fields.