v1

latestOpenAPI 3.0.32026-07-264469137.7 KB
Products

List products

Returns a paginated list of your products, most recent first. Archived products are excluded unless you pass include_archived=true. See Pagination for how to page through results. Requires the products:read scope.

get/v1/products

Query parameters

limitinteger
cursorstring
include_archivedboolean

Include archived products in the results. Defaults to false.

Response

Success

Example response

{
  "items": [
    {
      "id": "prod_1a2b3c4d5e6f",
      "organization_id": "org_abc123",
      "name": "Pro Plan",
      "description": "Monthly access to all Pro features.",
      "price": {
        "currency": "USD",
        "price_type": "fixed",
        "amount": "29.00",
        "preset_amount": "15.00",
        "minimum_amount": "5.00",
        "maximum_amount": "500.00",
        "currency_options": [
          {
            "currency": "GHS",
            "amount": "35.00",
            "minimum_amount": "5.00",
            "maximum_amount": "500.00"
          }
        ]
      },
      "status": "active",
      "metadata": {
        "order_id": "ORD-9876",
        "tier": "pro"
      },
      "actor_id": "usr_abc123",
      "created_at": "2026-07-13T14:00:00.000Z",
      "updated_at": "2026-07-13T14:00:00.000Z",
      "billing_cycle": {
        "interval": "month",
        "frequency": 1
      },
      "trial_period": {
        "interval": "day",
        "frequency": 14
      },
      "total_amount": "0.00"
    }
  ]
}