GET
/
subscriptions
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 subscription of client.subscriptions.list()) {
    console.log(subscription.product_id);
  }
}

main();
{
  "items": [
    {
      "cancelled_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "customer": {
        "customer_id": "<string>",
        "email": "<string>",
        "name": "<string>"
      },
      "discount_id": "<string>",
      "metadata": {},
      "next_billing_date": "2023-11-07T05:31:56Z",
      "payment_frequency_count": 123,
      "payment_frequency_interval": "Day",
      "product_id": "<string>",
      "quantity": 123,
      "recurring_pre_tax_amount": 123,
      "status": "pending",
      "subscription_id": "<string>",
      "subscription_period_count": 123,
      "subscription_period_interval": "Day",
      "tax_inclusive": true,
      "trial_period_days": 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

status
enum<string>

Filter by status

Available options:
pending,
active,
on_hold,
paused,
cancelled,
failed,
expired

Response

200 - application/json
items
object[]
required

Response struct representing subscription details