The Firmhouse Logo [FH]
Developer Docs
Home
Storefront JS SDK
New
API Reference
Liquid
Examples

OrderedProduct

Relation between subscription and a product that indicates the subscription is subscribed to this product in some way.

Fields

createdAt (ISO8601DateTime)
The time when the ordered product was created
graceCancellationEndsAt (ISO8601DateTime)
The time when the grace cancellation period ends
id (ID!)
ID to identify the ordered product with
interval (Int)
The amount of time in units between shipments of this order
intervalUnitOfMeasure (String)
The time measure for interval units
maximumCommitmentEndsAt (ISO8601DateTime)
The time when the maximum commitment period ends
metadata (JSON)
Metadata makes it possible to store additional information on objects.
minimumCommitmentEndsAt (ISO8601DateTime)
The time when the minimum commitment period ends
plan (Plan)
If added as part of a plan, this will be the reference.
priceExcludingTaxCents (Int)
The price of the product for this subscription excluding tax in cents
priceIncludingTaxCents (Int)
The price of the product for this subscription including tax in cents
product (Product!)
The associated product record for this order line
productId (ID!)
The ID of the associated product record
quantity (Int)
The amount ordered for this product
recurring (Boolean!)
Whether this product will get shipped or charged recurringly.
shipmentDate (String)
The next date on which a new order should get initiated
status (OrderedProductStatus!)
subscription (Subscription)
The associated product record for this ordered product
title (String)
Name of the product
totalAmountExcludingTaxCents (Int)
The total amount based on the unit price * quantity excluding tax, in cents
totalAmountIncludingTaxCents (Int)
The total amount based on the unit price * quantity including tax, in cents
totalOrdered (Int)
The total amount that the customer has ordered of this product upto now
updatedAt (ISO8601DateTime)
The time when the ordered product was updated