Skip to main content
PATCH
Update a product

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

The product ID

Body

application/json

Product update payload. Only supplied fields change. Changing a price field mints a new default price; existing subscriptions keep the price they were purchased under.

name
string

Name of the product

description
string

Description of the product

image_url
string

URL of the product image

Example:

"https://picsum.photos/200/300"

default_success_url
string

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

Example:

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

price
integer

The price of the product in cents. Must be 0 (free product) or at least 100 (one whole unit of the currency).

Example:

400

currency
enum<string>

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

Available options:
EUR,
USD
Example:

"USD"

billing_type
enum<string>

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

Available options:
recurring,
onetime
Example:

"recurring"

billing_period
enum<string>

Billing period, required if billing_type is recurring

Available options:
once,
every-day,
every-month,
every-three-months,
every-six-months,
every-year
Example:

"every-month"

tax_mode
enum<string>

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.

Available options:
inclusive,
exclusive
Example:

"inclusive"

pay_what_you_want
boolean

Enable pay-what-you-want pricing: the customer chooses the amount at checkout. The price field acts as the minimum the customer must pay. Only supported for one-time payment products.

Example:

false

suggested_price
integer

Suggested amount in cents, pre-filled at checkout when pay_what_you_want is enabled. Must be greater than or equal to price (the minimum). Ignored when pay_what_you_want is disabled.

Example:

1500

Response

Successfully updated the product

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

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

name
string
required

The name of the product

description
string
required

A brief description of the product

Example:

"This is a sample product description."

price
number
required

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

Example:

400

currency
string
required

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

Example:

"USD"

billing_type
enum<string>
required

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

Available options:
recurring,
onetime
Example:

"recurring"

billing_period
enum<string>
required

Billing period

Available options:
every-month,
every-three-months,
every-six-months,
every-year,
every-day,
once
Example:

"every-month"

status
enum<string>
required

Status of the product

Available options:
active,
archived
tax_mode
enum<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.

Available options:
inclusive,
exclusive
Example:

"inclusive"

tax_category
enum<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.

Available options:
saas,
digital-goods-service,
ebooks
Example:

"saas"

created_at
string<date-time>
required

Creation date of the product

Example:

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

updated_at
string<date-time>
required

Last updated date of the product

Example:

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

image_url
string

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

Example:

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

features
object[]

Features of the product.

product_url
string

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

Example:

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

default_success_url
string | null

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

Example:

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

custom_fields
object[] | null

Custom fields configured for the product. Collect additional information from your customer during checkout.