Update a product
Update a product. Only supplied fields change; changing a price field mints a new default price while existing subscriptions keep the price they were purchased under.
Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Path Parameters
The product ID
Body
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 of the product
Description of the product
URL of the product image
"https://picsum.photos/200/300"
The URL to which the user will be redirected after successfull payment.
"https://example.com/?status=successful"
The price of the product in cents. Must be 0 (free product) or at least 100 (one whole unit of the currency).
400
Three-letter ISO currency code, in uppercase. Must be a supported currency.
EUR, USD "USD"
Indicates the billing method for the customer. It can either be a recurring billing cycle or a onetime payment.
recurring, onetime "recurring"
Billing period, required if billing_type is recurring
once, every-day, every-month, every-three-months, every-six-months, every-year "every-month"
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, exclusive "inclusive"
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.
false
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.
1500
Response
Successfully updated the product
Unique identifier for the object.
String representing the environment.
test, prod, 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.
"USD"
Indicates the billing method for the customer. It can either be a recurring billing cycle or a onetime payment.
recurring, onetime "recurring"
Billing period
every-month, every-three-months, every-six-months, every-year, every-day, once "every-month"
Status of the product
active, archived 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, exclusive "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, digital-goods-service, ebooks "saas"
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"
Features of the product.
The product page you can redirect your customers to for express checkout.
"https://creem.io/product/prod_123123123123"
The URL to which the user will be redirected after successfull payment.
"https://example.com/?status=successful"
Custom fields configured for the product. Collect additional information from your customer during checkout.