List Products

Get a list of all products associated with your account.

GET /products

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const productListResponse of client.products.list()) {
  console.log(productListResponse.business_id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "entitlements": [
        {
          "id": "<string>",
          "integration_config": {
            "target_id": "<string>"
          },
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "is_recurring": true,
      "metadata": {},
      "product_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "image": "<string>",
      "name": "<string>",
      "price": 123,
      "price_detail": {
        "discount": 123,
        "price": 123,
        "purchasing_power_parity": true,
        "pay_what_you_want": true,
        "suggested_price": 123,
        "tax_inclusive": true
      },
      "tax_inclusive": true
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

page_size · integer<int32>

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32>

Page number default is 0

Required range: x >= 0

archived · boolean

List archived products

recurring · boolean

Filter products by pricing type:

• true: Show only recurring pricing products (e.g. subscriptions)
• false: Show only one-time price products
• null or absent: Show both types of products

brand_id · string

filter by Brand id

Response

200

application/json

Products List

items · object[] · required

Show child attributes