Interface DisputesApiListDisputesRequest

Request parameters for listDisputes operation in DisputesApi.

Export

DisputesApiListDisputesRequest

Hierarchy

  • DisputesApiListDisputesRequest

Properties

charge_id? created_at_gte? created_at_lte? include_connected_accounts? limit? offset? status? tilled_account

Properties

Optional Readonly charge_id

charge_id?: string

Only returns disputes for the charge specified by this charge ID.

Memberof

DisputesApiListDisputes

Optional Readonly created_at_gte

created_at_gte?: string

Minimum `created_at` value to filter by (inclusive).

Memberof

DisputesApiListDisputes

Optional Readonly created_at_lte

created_at_lte?: string

Maximum `created_at` value to filter by (inclusive).

Memberof

DisputesApiListDisputes

Optional Readonly include_connected_accounts

include_connected_accounts?: boolean

Whether or not to include the results from any connected accounts.

Memberof

DisputesApiListDisputes

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

DisputesApiListDisputes

Optional Readonly offset

offset?: number

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

Memberof

DisputesApiListDisputes

Optional Readonly status

status?: ListDisputesStatus[]

String indicating the status to filter the result by.

Memberof

DisputesApiListDisputes

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

DisputesApiListDisputes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc