Interface PaymentIntentsApiListPaymentIntentsRequest

Request parameters for listPaymentIntents operation in PaymentIntentsApi.

Export

PaymentIntentsApiListPaymentIntentsRequest

Hierarchy

  • PaymentIntentsApiListPaymentIntentsRequest

Properties

created_at_gte? created_at_lte? customer_id? include_connected_accounts? limit? metadata? offset? q? status? subscription_id? terminal_reader_id? tilled_account

Properties

Optional Readonly created_at_gte

created_at_gte?: string

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

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly created_at_lte

created_at_lte?: string

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

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly customer_id

customer_id?: string

The ID of the customer whose payment intents will be retrieved.

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly include_connected_accounts

include_connected_accounts?: boolean

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

Memberof

PaymentIntentsApiListPaymentIntents

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

PaymentIntentsApiListPaymentIntents

Optional Readonly metadata

metadata?: {
    [key: string]: string;
}

`metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

Memberof

PaymentIntentsApiListPaymentIntents

Type declaration

  • [key: string]: string

Optional Readonly offset

offset?: number

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

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly q

q?: string

Supports searching by `payment_intent.id`, `payment_intent.amount`, `payment_method.billing_details.name`, `payment_method.id`, `payment_method.details.last4`, `payment_method.details.last2`, `customer.first_name`, `customer.last_name`

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly status

status?: ListPaymentIntentsStatus[]

Only return PaymentIntents whose status is included by this array. Examples: `/v1/payment-intents?status=succeeded,requires_payment_method` and `/v1/payment-intents?status=succeeded&status=requires_payment_method`.

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly subscription_id

subscription_id?: string

The ID of the subscription whose payment intents will be retrieved.

Memberof

PaymentIntentsApiListPaymentIntents

Optional Readonly terminal_reader_id

terminal_reader_id?: string

The ID of the terminal reader for which payment intents will be retrieved.

Memberof

PaymentIntentsApiListPaymentIntents

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

PaymentIntentsApiListPaymentIntents

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc