Sign in
Products V2

Update Product

Updates a product's name, description, entitlements, or metadata. Requires products:write scope.

patch/v2/products/{id}

Path parameters

idstring required

Product ID

Product ID

Request body

application_idstring

Target application ID when moving a custom product back to an application-backed store

identifierstring

Platform-specific product identifier

namestring

Display name of the product

monthly_billing_plan_trial_period_daysnumber nullable

Monthly billing plan trial days. Null clears the monthly billing plan trial.

entitlementsstring[]

List of entitlement IDs to grant with this product

metadataobject

Arbitrary key-value metadata to attach to the product

Response

Success

idstring required

Unique identifier for the product

object'product' required

Object type, always product

application_idstring required

ID of the application this product is stored under

project_idstring required

ID of the project this product belongs to

identifierstring required

Platform-specific product identifier

namestring nullable required

Display name of the product, or null

monthly_billing_plan_trial_period_daysnumber nullable required

Monthly billing plan trial days, or null

entitlementsstring[] required

List of entitlement IDs granted by this product

created_atstring required

ISO 8601 timestamp of when the product was created

updated_atstring required

ISO 8601 timestamp of when the product was last updated

metadataobject required

Changes

No recorded changes to this endpoint across all 2 revisions of this API.