Sign in

v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB
Products

Archive a product

Archive a product (soft-delete). The product is retained for historical orders and subscriptions but can no longer be purchased.

delete/v1/products/{id}

Path parameters

idstring required

The product ID

Response

Successfully archived the product

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

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

namestring required

The name of the product

descriptionstring required

A brief description of the product

image_urlstring

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

image_urlsstring[]

Ordered list of product image URLs. The first entry is the cover image (mirrored in image_url).

pricenumber required

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

currencystring required

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

billing_type'recurring' | 'onetime' required

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

billing_period'every-month' | 'every-three-months' | 'every-six-months' | 'every-year' | 'every-day' | 'once' required

Billing period

status'active' | 'archived' required

Lifecycle status of the product: active or archived.

tax_mode'inclusive' | 'exclusive' 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.

tax_category'saas' | 'digital-goods-service' | 'ebooks' 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.

product_urlstring

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

default_success_urlstring nullable

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

created_atstring date-time required

Creation date of the product

updated_atstring date-time required

Last updated date of the product

Example response

{
  "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"
}