Interface CheckoutSessionsApiListCheckoutSessionsRequest

Request parameters for listCheckoutSessions operation in CheckoutSessionsApi.

Export

CheckoutSessionsApiListCheckoutSessionsRequest

Hierarchy

  • CheckoutSessionsApiListCheckoutSessionsRequest

Properties

customer_id? limit? metadata? offset? payment_intent_id? tilled_account

Properties

Optional Readonly customer_id

customer_id?: string

Only return the checkout session for the customer specified.

Memberof

CheckoutSessionsApiListCheckoutSessions

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

CheckoutSessionsApiListCheckoutSessions

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

CheckoutSessionsApiListCheckoutSessions

Type declaration

  • [key: string]: string

Optional Readonly offset

offset?: number

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

Memberof

CheckoutSessionsApiListCheckoutSessions

Optional Readonly payment_intent_id

payment_intent_id?: string

Only return the checkout session for the payment intent specified.

Memberof

CheckoutSessionsApiListCheckoutSessions

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

CheckoutSessionsApiListCheckoutSessions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc