Products

List all products

Changed on

Search and retrieve a paginated list of products. Filter by status, billing type, and other criteria.

get/v1/products/search

Request

Query parameters

page_numbernumber
Example:1

The page number for pagination.

page_sizenumber
Example:10

The number of items per page.

status'active' | 'archived'

Lifecycle status of the product: active or archived.

Response

Successfully retrieved products

Example response

{
  "items": [
    {
      "description": "This is a sample product description.",
      "image_url": "https://example.com/image.jpg",
      "image_urls": [
        "https://example.com/image.jpg"
      ],
      "features": [
        {
          "id": "feat_abc123",
          "description": "Access to premium course materials.",
          "customer_credits": {
            "amount": "100",
            "unit_label": "tokens",
            "bucket_name": "images"
          }
        }
      ],
      "usage_prices": [
        {
          "id": "price_abc123",
          "meter_id": "mtr_abc123",
          "unit_price": 0.002,
          "free_allowance": 1000,
          "cap": 50000,
          "target_account_name": "images"
        }
      ],
      "price": 400,
      "currency": "USD",
      "recurring_interval": "month",
      "recurring_interval_count": 3,
      "trial_period_days": 7,
      "trial_price": 100,
      "product_url": "https://creem.io/product/prod_123123123123",
      "default_success_url": "https://example.com/?status=successful",
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": 2
  }
}

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      the // response's property type changed from object to string for status

    • breaking

      the // response's property type changed from object to integer for status