List Products

List all products

curl --request GET \
  --url https://api.creem.io/v1/products/search \
  --header 'x-api-key: <x-api-key>'

{
  "items": [
    {
      "id": "<string>",
      "mode": "test",
      "object": "<string>",
      "name": "<string>",
      "description": "This is a sample product description.",
      "price": 400,
      "currency": "USD",
      "billing_type": "recurring",
      "billing_period": "every-month",
      "status": "<string>",
      "tax_mode": "inclusive",
      "tax_category": [
        "saas",
        "digital-goods-service",
        "ebooks"
      ],
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "image_url": "https://example.com/image.jpg",
      "features": [
        {
          "id": "<string>",
          "type": "<string>",
          "description": "Get access to discord server."
        }
      ],
      "product_url": "https://creem.io/product/prod_123123123123",
      "default_success_url": "https://example.com/?status=successful"
    }
  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null
  }
}

GET

products

List all products

curl --request GET \
  --url https://api.creem.io/v1/products/search \
  --header 'x-api-key: <x-api-key>'

{
  "items": [
    {
      "id": "<string>",
      "mode": "test",
      "object": "<string>",
      "name": "<string>",
      "description": "This is a sample product description.",
      "price": 400,
      "currency": "USD",
      "billing_type": "recurring",
      "billing_period": "every-month",
      "status": "<string>",
      "tax_mode": "inclusive",
      "tax_category": [
        "saas",
        "digital-goods-service",
        "ebooks"
      ],
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "image_url": "https://example.com/image.jpg",
      "features": [
        {
          "id": "<string>",
          "type": "<string>",
          "description": "Get access to discord server."
        }
      ],
      "product_url": "https://creem.io/product/prod_123123123123",
      "default_success_url": "https://example.com/?status=successful"
    }
  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1,
    "next_page": 2,
    "prev_page": null
  }
}

Headers

x-api-key

string

required

Query Parameters

page_number

number

The page number

page_size

number

The the page size

Response

200 - application/json

Successfully retrieved products

items

object[]

required

List of product items

Show child attributes

items.id

string

required

Unique identifier for the object.

items.mode

enum<string>

required

String representing the environment.

Available options:

test,

prod,

sandbox

items.object

string

required

String representing the object's type. Objects of the same type share the same value.

items.name

string

required

The name of the product

items.description

string

required

A brief description of the product

Example:

"This is a sample product description."

items.price

number

required

The price of the product in cents. 1000 = $10.00

Example:

400

items.currency

string

required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

Example:

"USD"

items.billing_type

string

required

Indicates the billing method for the customer. It can either be a recurring billing cycle or a onetime payment.

Example:

"recurring"

items.billing_period

string

required

Billing period

Example:

"every-month"

items.status

string

required

Status of the product

items.tax_mode

string

required

Specifies the tax calculation mode for the transaction. If set to "inclusive," the tax is included in the price. If set to "exclusive," the tax is added on top of the price.

Example:

"inclusive"

items.tax_category

string

required

Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service.

Example:

["saas", "digital-goods-service", "ebooks"]

items.created_at

string<date-time>

required

Creation date of the product

Example:

"2023-01-01T00:00:00Z"

items.updated_at

string<date-time>

required

Last updated date of the product

Example:

"2023-01-01T00:00:00Z"

items.image_url

string

URL of the product image. Only png as jpg are supported

Example:

"https://example.com/image.jpg"

items.features

object[]

Features of the product.

Show child attributes

items.features.id

string

required

Unique identifier for the feature.

items.features.type

string

required

The feature type.

items.features.description

string

required

A brief description of the feature

Example:

"Get access to discord server."

items.product_url

string

The product page you can redirect your customers to for express checkout.

Example:

"https://creem.io/product/prod_123123123123"

items.default_success_url

string | null

The URL to which the user will be redirected after successfull payment.

Example:

"https://example.com/?status=successful"

pagination

object

required

Pagination details for the list

Show child attributes

pagination.total_records

number

required

Total number of records in the list

Example:

0

pagination.total_pages

number

required

Total number of pages available

Example:

0

pagination.current_page

number

required

The current page number

Example:

1

pagination.next_page

number | null

required

The next page number, or null if there is no next page

Example:

2

pagination.prev_page

number | null

required

The previous page number, or null if there is no previous page

Example:

null

Get Product Get Customer

⌘I

API Documentation

Checkout

Product

Customer

Transactions

License

Discount Code

Subscription

List Products

Headers

Query Parameters

Response