Creates an ordered product on a subscription.
input (CreateOrderedProductV2Input!)
Parameters for CreateOrderedProductV2
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, with the plan discount applied when a plan is present.
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
ensureNewRecord (Boolean)
subscriptionId (ID)
ID of the subscription to create this OrderedProduct for. Required if authenticated via a project access token
sku (String)
Use this field to look up the associated product based on SKU.
slug (String)
Use this field to look up the associated product based on slug.
shopifyVariantId (ID)
Use this field to look up the associated product based on Shopify Variant ID.
skipPlanGroupCheck (Boolean)
When true, allows adding a product that is outside the subscription's current plan group.
orderedProductType (OrderedProductTypes)
Type of ordered product.
Last updated
Was this helpful?
Was this helpful?
