ChargeListParams
Extends
Properties
address_id?
address_id?:
string|number
Filter Charges by Address.
created_at_max?
created_at_max?:
string
Show Charges created before the given date.
created_at_min?
created_at_min?:
string
Show Charges created after the given date.
cursor?
cursor?:
string
next or previous cursor returned by previous list call
Inherited from
discount_code?
discount_code?:
string
List Charges that contain the given discount_code.
discount_id?
discount_id?:
string|number
List Charges that contain the given discount_id.
external_order_id?
external_order_id?:
string|number
Filter Charges by the associated order ID in the external e-commerce platform.
ids?
ids?: (
string|number)[]
Filter Charges by list of IDs.
include?
include?:
ChargeIncludes[]
Include related data options
limit?
limit?:
number
default is 50, max is 250
Inherited from
processed_at_max?
processed_at_max?:
string
Show charges processed after, and including, the given date.
processed_at_min?
processed_at_min?:
string
Show charges processed before, and including, the given date.
purchase_item_id?
purchase_item_id?:
string|number
Filter Charges by a Subscription or Onetime ID.
purchase_item_ids?
purchase_item_ids?: (
string|number)[]
Filter Charges by list of Subscription or Onetime IDs.
scheduled_at?
scheduled_at?:
string
Filter Charges by specific scheduled charge date.
scheduled_at_max?
scheduled_at_max?:
string
Show Charges scheduled to be processed before the given date.
scheduled_at_min?
scheduled_at_min?:
string
Show Charges scheduled to be processed after the given date.
sort_by?
sort_by?:
ChargeSortBy
sort list by option
Inherited from
status?
status?:
ChargeStatus[]
Filter charges by status.
updated_at_max?
updated_at_max?:
string
Show charges updated before the given date.
updated_at_min?
updated_at_min?:
string
Show charges updated after the given date.
Generated using typedoc-plugin-markdown and TypeDoc