GET
/
payments
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const paymentListResponse of client.payments.list()) {
    console.log(paymentListResponse.payment_id);
  }
}

main();
{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "customer": {
        "customer_id": "<string>",
        "email": "<string>",
        "name": "<string>"
      },
      "metadata": {},
      "payment_id": "<string>",
      "payment_method": "<string>",
      "payment_method_type": "<string>",
      "status": "succeeded",
      "subscription_id": "<string>",
      "total_amount": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
created_at_gte
string | null

Get events after this created time

​
created_at_lte
string | null

Get events created before this time

​
page_size
integer | null

Page size default is 10 max is 100

Required range: x >= 0
​
page_number
integer | null

Page number default is 0

Required range: x >= 0
​
customer_id
string | null

Filter by customer id

​
subscription_id
string | null

Filter by subscription id

​
status
enum<string>

Filter by status

Available options:
succeeded,
failed,
cancelled,
processing,
requires_customer_action,
requires_merchant_action,
requires_payment_method,
requires_confirmation,
requires_capture,
partially_captured,
partially_captured_and_capturable

Response

200 - application/json
​
items
object[]
required