Skip to main content

Interface: PaymentMethodListParams

Extends​

Properties​

address_id?​

optional address_id: string | number

Return the payment_methods linked to the given address_id.

cursor?​

optional cursor: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

include?​

optional include: "addresses"[]

Include related data options

include_deleted?​

optional include_deleted: boolean

Include deleted payment methods

limit?​

optional limit: number

default is 50, max is 250

Inherited from​

ListParams.limit

processor_name?​

optional processor_name: ProcessorName

Return the payment_methods linked to the given processor_name.

processor_payment_method_token?​

optional processor_payment_method_token: string

Return the payment_methods linked to the given processor_payment_method_token.

sort_by?​

optional sort_by: null

sort list by option

Inherited from​

ListParams.sort_by