Update a product
Update a product. Only supplied fields change; a price change mints a new default price.
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
Name of the product
Description of the product
URL of the product image
Ordered list of product image URLs (max 8). The first entry is the cover image; when provided it takes precedence over image_url. An empty list removes all images.
Redirect URL after successful payment.
The price of the product in cents. Must be 0 (free product) or at least 100 (one whole unit of the currency).
Three-letter uppercase ISO 4217 currency code. Must be one of Creem's supported currencies.
EUR, USD "USD"
Billing method for the product: recurring subscription or onetime payment.
recurring, onetime "recurring"
Billing interval. Required when 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 (one-time only).
Suggested amount in cents when pay_what_you_want is enabled.
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"
Lifecycle status of the product: active or archived.
active, archived "active"
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"
Ordered list of product image URLs. The first entry is the cover image (mirrored in image_url).
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.