Updates an ordered product
For an in-place product replacement, pass the existing ordered product id and the new productId. Omitted fields keep their existing values, making this the preferred way to swap a subscribed product under the same conditions and pricing.
input (UpdateOrderedProductInput!)
Parameters for UpdateOrderedProduct
metadata (JSON)
Metadata that can be used by developers to store additional information on objects.
id (ID)
ID of this ordered product. This will be ignored on create action.
productId (ID)
ID for the related product. When replacing a product, this is the replacement product.
quantity (Int)
The quantity for this ordered product.
customPriceCents (Int)
A custom price in cents for this ordered product, if left blank the default product price will be used
shipmentDate (ISO8601Date)
The next date on which a new order should get initiated
interval (Int)
The amount of time in units between shipments of this order
intervalUnitOfMeasureType (OrderedProductIntervalUnitOfMeasure)
The time measure for interval units
status (OrderedProductStatus)
The status of the ordered product
minimumCommitmentEndsAt (ISO8601Date)
The date at which the minimum commitment ends for this product
maximumCommitmentEndsAt (ISO8601Date)
The date at which the maximum commitment ends for this product
Last updated
Was this helpful?
Was this helpful?
