Skip to main content

Interface: ChargeListParams

Extends​

Properties​

address_id?​

optional address_id?: string | number

Filter Charges by Address.

created_at_max?​

optional created_at_max?: string

Show Charges created before the given date.

created_at_min?​

optional created_at_min?: string

Show Charges created after the given date.

cursor?​

optional cursor?: string

next or previous cursor returned by previous list call

Inherited from​

ListParams.cursor

discount_code?​

optional discount_code?: string

List Charges that contain the given discount_code.

discount_id?​

optional discount_id?: string | number

List Charges that contain the given discount_id.

external_order_id?​

optional external_order_id?: string | number

Filter Charges by the associated order ID in the external e-commerce platform.

ids?​

optional ids?: (string | number)[]

Filter Charges by list of IDs.

include?​

optional include?: ChargeIncludes[]

Include related data options

limit?​

optional limit?: number

default is 50, max is 250

Inherited from​

ListParams.limit

processed_at_max?​

optional processed_at_max?: string

Show charges processed after, and including, the given date.

processed_at_min?​

optional processed_at_min?: string

Show charges processed before, and including, the given date.

purchase_item_id?​

optional purchase_item_id?: string | number

Filter Charges by a Subscription or Onetime ID.

purchase_item_ids?​

optional purchase_item_ids?: (string | number)[]

Filter Charges by list of Subscription or Onetime IDs.

scheduled_at?​

optional scheduled_at?: string

Filter Charges by specific scheduled charge date.

scheduled_at_max?​

optional scheduled_at_max?: string

Show Charges scheduled to be processed before the given date.

scheduled_at_min?​

optional scheduled_at_min?: string

Show Charges scheduled to be processed after the given date.

sort_by?​

optional sort_by?: ChargeSortBy

sort list by option

Inherited from​

ListParams.sort_by

status?​

optional status?: ChargeStatus[]

Filter charges by status.

updated_at_max?​

optional updated_at_max?: string

Show charges updated before the given date.

updated_at_min?​

optional updated_at_min?: string

Show charges updated after the given date.