List 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.",
"image_url": "https://example.com/image.jpg",
"features": [
{
"id": "<string>",
"type": "<string>",
"description": "Get access to discord server."
}
],
"price": 400,
"currency": "EUR",
"billing_type": "recurring",
"billing_period": "every-month",
"status": "<string>",
"tax_mode": "inclusive",
"tax_category": "saas",
"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": {
"total_records": 0,
"total_pages": 0,
"current_page": 1,
"next_page": 2,
"prev_page": null
}
}Headers
Response
List of product items
Unique identifier for the object.
String representing the environment.
test, live, sandbox String representing the object’s type. Objects of the same type share the same value.
The name of the product
A brief description of the product
"This is a sample product description."
The price of the product in cents. 1000 = $10.00
400
Three-letter ISO currency code, in uppercase. Must be a supported currency.
"EUR"
Indicates the billing method for the customer. It can either be a recurring billing cycle or a onetime payment.
"recurring"
Billing period
"every-month"
Status of the product
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.
"inclusive"
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.
"saas"
The product page you can redirect your customers to for express checkout.
"https://creem.io/product/prod_123123123123"
Creation date of the product
"2023-01-01T00:00:00Z"
Last updated date of the product
"2023-01-01T00:00:00Z"
URL of the product image. Only png as jpg are supported
"https://example.com/image.jpg"
The URL to which the user will be redirected after successfull payment.
"https://example.com/?status=successful"
Pagination details for the list
Total number of records in the list
0
Total number of pages available
0
The current page number
1
The next page number, or null if there is no next page
2
The previous page number, or null if there is no previous page
null
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.",
"image_url": "https://example.com/image.jpg",
"features": [
{
"id": "<string>",
"type": "<string>",
"description": "Get access to discord server."
}
],
"price": 400,
"currency": "EUR",
"billing_type": "recurring",
"billing_period": "every-month",
"status": "<string>",
"tax_mode": "inclusive",
"tax_category": "saas",
"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": {
"total_records": 0,
"total_pages": 0,
"current_page": 1,
"next_page": 2,
"prev_page": null
}
}