import type * as Whop from "../../../../index.js"; /** * @example * { * currencies: ["usd"], * variant_ids: ["plan_xxxxxxxxxxxxx"], * product_ids: ["prod_xxxxxxxxxxxxx"] * } */ export interface SummaryPaymentsRequest { /** Which breakdowns to return, keyed by these names under `groups`. Repeat the parameter to ask for several; omit it for all of them. */ groups?: Whop.SummaryPaymentsRequestGroupsItem | Whop.SummaryPaymentsRequestGroupsItem[]; /** Only payments charged by this account, prefixed `biz_`. */ account_id?: string; /** Only payments in any of these lifecycle states. Repeat the parameter to pass several. */ statuses?: Whop.SummaryPaymentsRequestStatusesItem | Whop.SummaryPaymentsRequestStatusesItem[]; /** Only payments whose `substatus` is any of these. Repeat the parameter to pass several. */ substatuses?: Whop.SummaryPaymentsRequestSubstatusesItem | Whop.SummaryPaymentsRequestSubstatusesItem[]; /** Only payments charged for any of these reasons. Repeat the parameter to pass several. */ billing_reasons?: Whop.SummaryPaymentsRequestBillingReasonsItem | Whop.SummaryPaymentsRequestBillingReasonsItem[]; /** Only payments presented in any of these three-letter currencies. Repeat the parameter to pass several. */ currencies?: string | string[]; /** Only payments priced by any of these variants, each prefixed `plan_`. Repeat the parameter to pass several. */ variant_ids?: string | string[]; /** Only payments for any of these products, each prefixed `prod_`. Repeat the parameter to pass several. */ product_ids?: string | string[]; /** Only payments paid with any of these methods. Repeat the parameter to pass several. */ payment_methods?: Whop.SummaryPaymentsRequestPaymentMethodsItem | Whop.SummaryPaymentsRequestPaymentMethodsItem[]; /** Only payments in any of these tracking states. Requires `account_id` and the shipment:basic:read permission. */ tracking_states?: Whop.SummaryPaymentsRequestTrackingStatesItem | Whop.SummaryPaymentsRequestTrackingStatesItem[]; /** Only payments created after this ISO 8601 timestamp. */ created_after?: string; /** Only payments created before this ISO 8601 timestamp. */ created_before?: string; /** Only payments refunded after this ISO 8601 timestamp. */ refunded_after?: string; /** Only payments refunded before this ISO 8601 timestamp. */ refunded_before?: string; /** Only payments with a dispute alert after this ISO 8601 timestamp. */ dispute_alerted_after?: string; /** Only payments with a dispute alert before this ISO 8601 timestamp. */ dispute_alerted_before?: string; /** Only payments with a dispute opened after this ISO 8601 timestamp. */ dispute_created_after?: string; /** Only payments with a dispute opened before this ISO 8601 timestamp. */ dispute_created_before?: string; /** Search payments by payment ID, dispute ID, user ID, membership ID, user email, name, or username. */ query?: string; /** Only for searches: with `query`, also search the account's connected accounts. Requires `account_id` and `query`, and is a 400 without either; it never lists connected accounts' payments on its own. Matches on payment, dispute, user or membership ID, buyer email, or a card's first 6 or 8 digits and last 4 separated by a space or dash (`424242 4242`). Free-text queries such as a name search only the named account. Connected accounts' payments are returned only for connected accounts you can read payments on. */ include_connected_accounts?: boolean; }