Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Bearer credential for the public API: a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Dashboard sign-in tokens are not accepted.

Query Parameters

buyer_email
string

Exact match against the order's buyer email, case-insensitive.

cash_flow_from
string

Inclusive lower bound on cash_flow_at (when funds became available), ISO 8601. A bare date (YYYY-MM-DD) expands to the beginning of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

cash_flow_to
string

Inclusive upper bound on cash_flow_at (when funds became available), ISO 8601. A bare date (YYYY-MM-DD) expands to the end of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

created_from
string

Inclusive lower bound on created_at (the sale timestamp), ISO 8601. A bare date (YYYY-MM-DD) expands to the beginning of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

created_to
string

Inclusive upper bound on created_at (the sale timestamp), ISO 8601. A bare date (YYYY-MM-DD) expands to the end of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

payment_method
string

Which payment methods to return: one name or several separated by commas (card,sepa). The names are the values payment_method carries: card, klarna, affirm, sepa, ach, afterpay_clearpay, paypal, terminal, other, interac_present, kr_card, alma, billie, scalapay, sequra, sunbit, zip, acss_debit, au_becs_debit, bacs_debit, nz_bank_account, payto, ideal, bancontact, eps, fpx, giropay, p24, sofort, pay_by_bank, link, amazon_pay, cashapp, alipay, wechat_pay, grabpay, revolut_pay, mobilepay, twint, satispay, bizum, mb_way, kakao_pay, naver_pay, payco, samsung_pay, paypay, swish, blik, paynow, pix, promptpay, upi, boleto, konbini, multibanco, oxxo, crypto. Without it every payment method is returned. An unknown name or an empty element is refused with 422.

status
string

Which sale statuses to return: trial, pending, succeeded, failed, or several separated by commas (pending,failed). trial: a free trial started, nothing charged yet. pending: the charge is processing. succeeded: paid. failed: the charge did not go through. Without it only succeeded sales whose funds availability date is known are returned, exactly as before this parameter existed; named, it filters on status alone, so succeeded also returns a sale whose funds date is not known yet. An unknown name or an empty element is refused with 422.

subscription_id
string

Only the payments of this subscription, by its ps_ id: the first charge and every renewal. Surrounding whitespace is stripped. An id that is not one of your subscriptions, including an instalment plan's, is refused with 422 validation_failed.

Pattern: ^ps_[A-Za-z0-9]{8,32}$
page
integer

Page number for paginated results. Values below 1 and non-numeric values are ignored and the first page is returned; a page past the last one returns the last page. current_page is accepted as an older name for it and wins when both are sent.

Required range: x >= 1
per_page
integer

Number of records per page. Defaults to 12; values above 100 are clamped to 100; values below 1 and non-numeric values are ignored and the default is used. items and limit are accepted as older names for it, read only when per_page is absent.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
pagination
object
required