Interface WebhookEndpointsApiListWebhookEndpointsRequest

Request parameters for listWebhookEndpoints operation in WebhookEndpointsApi.

Export

WebhookEndpointsApiListWebhookEndpointsRequest

Hierarchy

  • WebhookEndpointsApiListWebhookEndpointsRequest

Properties

include_connected_accounts? limit? offset? tilled_account

Properties

Optional Readonly include_connected_accounts

include_connected_accounts?: boolean

When true, returns webhook endpoints across the caller account and all descendant merchant accounts. Without this, only endpoints owned by the caller account are returned. Mirrors the same flag on `EventListQueryParams`.

Memberof

WebhookEndpointsApiListWebhookEndpoints

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

WebhookEndpointsApiListWebhookEndpoints

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

WebhookEndpointsApiListWebhookEndpoints

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

WebhookEndpointsApiListWebhookEndpoints

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc