Products

List all products

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

get/v1/products/search

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.

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."
        }
      ],
      "price": 400,
      "currency": "USD",
      "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

Changed in 2 of the 4 revisions of this API.14

  • 098b518de5cd12See the full diff
    • added the new custom enum value to the items/items/billing_period response property for the response status 200

      response-property-enum-value-added

    • added the optional property items/items/recurring_interval to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/recurring_interval_count to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter status

      new-optional-request-parameter

    • added the optional property items/items/image_urls to the response with the 200 status

      response-optional-property-added