"summary" shows the cart summary and closes the checkout panel.
"checkout" opens the checkout. When checkoutUrl is configured, the
widget sends the page to that URL with the cart ID appended and stops, so
nothing opens. The embedded checkout view needs both the
checkoutWidget and the embedCheckout limits on the shop; without
them the widget sends the page to the hosted Subbly checkout instead.
Any other string opens the widget without changing the view.
true opens the widget with the summary shown, false with it hidden.
Both leave the active customization view mounted.
Every string value unmounts the customization view, unless "checkout"
hands over to another page.
Returnsvoid
Open the widget
subblyCart.open()// Open the checkoutsubblyCart.open('checkout')// Open without the summarysubblyCart.open(false)
subblyCart.close()
Closes the widget. It hides the summary, unmounts any customization view, and
clears the widget error. The call does nothing when the widget is already
closed. It emits CART_CLOSE.
Returnsvoid
Close the widget
subblyCart.close()
subblyCart.toggle()
Opens the widget when it is closed, closes it when it is open. It always opens
on the summary. It emits CART_OPEN or CART_CLOSE.
Returnsvoid
Toggle the widget
subblyCart.toggle()
subblyCart.loadShop()
Returns the shop the widget already holds. It refreshes subblyCart.shop in
place, so every reference you hold sees the same object. It calls the API only
when no shop is loaded yet, which cannot happen after initialize, so in
practice it never re-reads the shop.
ReturnsPromise<SubblyShop>
The shop.
Reload the shop
const shop = await subblyCart.loadShop()
subblyCart.updateCart(payload)
Applies cart-level changes — currency, coupon, addresses, shipping, gift
details — and refreshes the widget, open or closed. Calls run in order through
an internal queue, so concurrent updates do not race each other. A cart that
was already purchased is reset first, which emits CART_RESET. The method
throws The cart is not initialized when the widget holds no cart. It emits
CART_UPDATED.
Method parameters
payloadRequiredPartial<CartUpdatePayload>
The cart fields to change. Every field is optional.
Adds a product, a bundle, or a survey, and asks the customer for what is
missing. Use it when you hold a parent product ID, a bundle ID, or a survey ID,
and addItem when you already hold a variant or a plan.
The widget creates a cart when there is none, and opens itself unless the shop
setting afterItemAdded is close. It then mounts the view the item needs:
pricing, variant, survey, survey flow, bundle, bundle plan, voucher,
subscription replacement, out of stock, or error. It emits CART_UPDATED once
the item lands in the cart.
Method parameters
payloadRequiredConfigureItemPayload
What to add. Pass one of productId, bundleId or surveyId.
ReturnsPromise<{ finalized: boolean }>
The promise stays pending while the customization view is open, and resolves
once the customer closes it. It never resolves with finalized: false, so the
useful signal is when it resolves, not what it carries.
Adds an item that needs no further input straight to the cart. The productId
must be a variant ID or a plan ID. A cart that was already purchased is reset
first, which emits CART_RESET. On failure the widget shows its error view
and rejects, so your catch runs as well. It emits CART_UPDATED.
Changes a line that is already in the cart. The payload has no required field,
so TypeScript cannot tell the three shapes apart; pick the one that matches the
line. There is no productId and no metadata — both are add-time only. It
emits CART_UPDATED.
Method parameters
cartItemIdRequiredstring
ID of the line, as a UUID. Read it from subblyCart.cart.items[].id.
Applies a coupon code to the cart. It is shorthand for
updateCart({ couponCode }), and it emits CART_UPDATED. The call rejects
when the coupon is invalid or does not fit what the cart holds, so a coupon
tied to a product fails on an empty cart. Use setPendingCoupon to hold such a
code until the product is in the cart.
Holds a coupon code and applies it once the cart holds the right products.
Nothing happens at once: the widget applies the code the next time the summary
or the checkout renders, so a product-restricted coupon is checked against a
cart that already holds the product.
The code is dropped after one attempt, and skipped when it matches the coupon
already on the cart. Failures are silent. This is what a ?coupon=CODE buy
link uses.
Removes the gift card from the cart. It calls
updateCart({ giftCardCode: null }) and emits CART_UPDATED.
ReturnsPromise<SubblyCart>
The updated cart.
Remove the gift card
const cart = await subblyCart.removeGiftCard()
subblyCart.setLanguage(langCode)
Switches the language of the widget and asks the API for translated responses.
The shop must publish the language; otherwise the widget falls back to the
shop's own languages, then to en. It updates subblyCart.state.languageCode
and emits no event. An empty value throws
Cart Widget:setLanguage Language code is required.
Without this call the widget takes the language from languageCode in the
config. If that is missing it tries the lang query parameter, then the lang
attribute of <html>, then the browser.
Method parameters
langCodeRequiredstring
Two-letter language code, such as fr. It must be one of
subblyCart.shop.languages[].code.
Returnsvoid
Switch to French
subblyCart.setLanguage('fr')
subblyCart.setCurrency(currencyCode)
Switches the currency of the cart and re-prices every line. It also re-prices
the products, bundles and surveys the SDK loads next, and updates
subblyCart.state.currencyCode. An empty value throws
Cart Widget:setCurrency currency code is required. It emits CART_UPDATED.
Method parameters
currencyCodeRequiredstring
ISO 4217 code, such as GBP. It must be one of
subblyCart.shop.currencies[].abbreviation.
ReturnsPromise<SubblyCart>
The updated cart.
Switch to pounds
const cart = await subblyCart.setCurrency('GBP')
subblyCart.resetCart()
Discards the cart and creates an empty one with the same currency. The new cart
ID replaces the old one in the subbly_cart_id cookie. Any open customization
view is unmounted. It emits CART_UPDATED, then CART_RESET.
ReturnsPromise<SubblyCart>
The new cart.
Start a new cart
const cart = await subblyCart.resetCart()
subblyCart.setSettings(settings)
Overrides the shop's cart settings at runtime: colours, typography, layout and
behaviour. Keys you omit keep their value. The widget recomputes the CSS
custom properties on its container, and loads the Google font named by
fontStyle by adding a <link> to the head. Nothing is stored, so a page
reload brings the shop's own settings back.
Method parameters
settingsRequiredPartial<ShopCartSettings>
The settings to change.
Returnsvoid
The method runs asynchronously and returns nothing worth waiting for.
Prefills the checkout with an email and consent flags for a guest. The call
does nothing when a customer is already signed in. The same data can come from
the email, marketingConsent and tosConsent query parameters.
Signs a customer in with a Subbly access token. The widget checks the token
against the API first. A token you pass is written to the subbly_access_token
cookie; a token that fails the check is cleared. On success the widget fetches
the customer and emits SIGN_IN.
Method parameters
accessTokenoptionalstring
A customer access token. Without it the widget checks the token in the
subbly_access_token cookie.
ReturnsPromise<void>
The promise rejects with Cart Widget:authenticate Authentication failed. The provided token is invalid or expired. when the token does not check out.
Sign a customer in
await subblyCart.authenticate(myAccessToken)
subblyCart.signOut()
Signs the current customer out of the widget. It clears the widget's sign-in
state and the subbly_access_token cookie, and emits SIGN_OUT. The cart
stays as it is.
ReturnsPromise<void>
Sign the customer out
await subblyCart.signOut()
subblyCart.reload(cartId?)
Re-reads the cart and the sign-in state from the API. Use it on a page that
rebuilds the cart itself, such as your own checkout. The widget re-checks the
shared access token and signs itself out when the token is gone, without
touching the cart; a failed check is ignored and the cart still reloads. It
emits CART_UPDATED.
Method parameters
cartIdoptionalstring
Point the widget at this cart, as a UUID, and write it to the
subbly_cart_id cookie for 365 days. Without it the widget reloads the
cart it already holds.
Merges new URL configuration into the running widget, and checks the current
URL against it at once. Each field merges over the current value, so a field
you leave out keeps what the config set at init. disableUrls keeps the list
the widget already holds: it is not rebuilt from the new checkoutUrl or
cartSummaryUrl. Only an empty list falls back to those URLs.
Makes the widget stand down: no panel, no cart button, no checkout. The
override sits on top of the URL rules, so the widget stays disabled while
either this override is set or the URL matches a disableUrls pattern.
Older deployments may not have the method yet, so call it with optional
chaining.
Returnsvoid
Stand the widget down
window.subblyCart?.disable?.()
subblyCart.enable()
Clears the disable override. The widget comes back only when the current URL no
longer matches a disable pattern. A widget that first mounted disabled runs its
one-time start-up now.
Returnsvoid
Bring the widget back
window.subblyCart?.enable?.()
SubblyCart.initialize(config)
Boots the widget by hand. You need it only with init: false, and you call it
on the class at window.SubblyCart, not on an instance.
It creates the container element, starts the SDK, mounts the app, applies the
settings, and emits CART_READY. It does not set a global: the name in
globalName is only assigned on the automatic path, so keep the instance the
promise gives you.
Method parameters
configRequiredCartWidgetConfig
The same object you would put in window.subblyConfig. See
Configuration keys for every key.
ReturnsPromise<CartWidget>
The widget instance: the object every method and property on these pages
belongs to.
HTML the merchant added under Shop settings, Checkout JS. The widget injects
it into the page.
conversionTrackingCodestring | null
HTML the merchant added for conversion tracking.
supportEmailstring
Support email address.
supportUrlstring
Support page URL.
termsAndConditionsstring
URL of the terms the customer accepts at checkout.
localPickupOnlyboolean
true when the shop only offers local pickup.
brandingobject
Logo and colour of the shop.
cartSettingsShopCartSettings
Theme and behaviour of the widget, as the merchant saved them.
subblyCart.setSettings overrides these at runtime.
countryobject
Country the shop trades from. Holds id, name, code and currencyCode.
currenciesShopCurrency[]
Currencies the shop sells in.
languagesShopLanguage[]
Languages the shop publishes.
limitsobject
Features the shop's plan allows.
referralSettingsobject | null
Referral programme. Holds enabled, refereeDiscount and
referralDiscount.
settingsShopSettings
Checkout behaviour of the shop.
shippingCountriesCountry[]
Countries the shop ships to. Each has id, code, codeIso3, name,
regionTitle, regions (each with id, code and name) and
scaRequired.
appsShopApp[]
Third-party apps the merchant connected. Each has a type and a
properties object: ga has propertyId, google_tag has containerId,
facebook_pixel and tiktok_pixel have pixelId and
renewalEventEnabled, zendesk has jsSnippet, intercom has
intercomId, facebook_login has appId, google_login has clientId,
cart_stack has apiKey and scriptUrl, bablic has jsCode and
checkoutOnly, and manychat has jsSnippet and widgetId.
currencyCodeoptionalstring
Currency of the cart, as an ISO 4217 code, such as EUR. It must be one of
subblyCart.shop.currencies[].abbreviation.
couponCodeoptionalstring | null
Coupon to apply. null removes the coupon.
giftCardCodeoptionalstring | null
Gift card to apply, as a UUID. null removes the gift card.
referralIdoptionalnumber | null
ID of the referring customer.
startsAtoptionalstring | null
Date the subscription starts, as YYYY-MM-DD.
onboardingTemplateIdoptionalnumber | null
ID of the onboarding template the cart follows.
giftInfooptionalobject | null
Gift details. All four keys must be present inside the object; each may be
null.
customeroptionalobject | null
Details of the guest buying the cart.
shippingAddressoptionalobject | null
Where the order ships.
shippingAddressIdoptionalnumber | null
ID of a saved address or of a pickup record, instead of a new address.
billingAddressoptionalobject | null
Billing address. Same fields as shippingAddress.
billingAddressIdoptionalnumber | null
ID of a saved billing address.
pickupInfooptionalobject | null
Who collects the order from a pickup point.
shippingMethodIdoptionalnumber | null
ID of the shipping method, from subblyCart.sdk.cart.getShippingMethods().
shippingCarrierIdoptionalnumber | null
ID of the carrier.
shippingCarrierServiceoptionalstring | null
Service code of the carrier.
paymentMethodIdoptionalnumber | null
ID of a saved payment method. The customer must be signed in.
metadataoptionalobject[] | null
Metafield values to store on the cart.
idstring
ID of the cart, as a UUID.
shopIdnumber
ID of the shop the cart belongs to.
statusstring
initialized, abandoned, expired, completed or restored.
attachedboolean
true once a customer is attached to the cart.
currencyCodestring
Currency the cart is priced in, as an ISO 4217 code.
baseCurrencyCodestring
Default currency of the shop.
itemsCartItem[]
Lines in the cart. An item carries no money. The amounts are in
summaryItems, joined on summaryItems[].itemId === items[].id.
summaryItemsCartSummaryItem[]
Priced lines. This is where the money lives.
subTotalnumber
Cart total before discount and tax, in the minor unit.
discountTotalnumber
Discount across the cart, in the minor unit.
discountsCartDiscount[]
Every discount on the cart.
taxTotalnumber
Tax across the cart, in the minor unit.
taxRatenumber
Deprecated. Rates differ per line; read summaryItems[].taxRate.
customsFeenumber
Customs fee charged today, in the minor unit.
futureCustomsFeenumber
Customs fee on later shipments, in the minor unit.
adjustmentnumber
Top-up that lifts the payment to the minimum the gateway accepts.
totalnumber
Grand total across today's payment and the future one. This is not the
amount charged today.
balanceChangeobject
Change to the customer's store balance. Holds amount and currencyCode.
couponCodestring | null
Code of the applied coupon.
couponCoupon | null
The applied coupon. The widget always expands it.
giftCardCodestring | null
Code of the applied gift card.
giftCardGiftCard | null
The applied gift card. The widget always expands it.
giftInfoobject
Gift details of the cart. Always an object.
startsAtstring | null
Date the subscription starts, as YYYY-MM-DD.
referralIdnumber | null
ID of the referring customer.
onboardingTemplateIdnumber | null
ID of the onboarding template the cart follows.
customerIdnumber | null
ID of the attached customer.
customerobject | null
Guest details, before a customer is attached. null afterwards.
Where the order ships, or the pickup point the customer chose.
shippingAddressIdnumber | null
ID of the shipping address or of the pickup record.
billingAddressCustomerAddress | null
Billing address. Same fields as a delivery address.
billingAddressIdnumber | null
ID of the billing address.
shippingMethodShippingMethod | null
The chosen shipping method.
shippingMethodIdnumber | null
ID of the shipping method.
shippingCarrierShippingCarrier | null
The carrier that delivers the order. Holds id, name and serviceCodes.
shippingCarrierIdnumber | null
ID of the carrier.
shippingCarrierServicestring | null
Service code of the carrier, such as an express service.
paymentMethodPaymentMethod | null
The saved payment method on the cart. Only present for a signed-in customer.
paymentMethodIdnumber | null
ID of the payment method.
metadataMetafield[] | null
Metafields stored on the cart.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
productIdConditionally requirednumber
ID of the variant, of the plan, or of the parent product the customer still
has to configure. Required unless you pass bundleId or surveyId.
bundleIdConditionally requirednumber
ID of the bundle to build. Required unless you pass productId or
surveyId.
surveyIdConditionally requirednumber
ID of the survey to run. Required unless you pass productId or bundleId.
quantityoptionalnumber
How many units to add.
metadataoptionalobject[] | null
Metafield values to store on the line.
idRequirednumber
ID of the metafield.
valuesRequiredobject[]
One entry per value: { id } when the metafield has preset values,
{ value } when the customer types the value.
optionsoptionalobject[] | null
Survey answers, when you already have them.
questionIdRequirednumber
ID of the question.
answersRequiredobject[]
The answers. The shape follows the question type: { content } for
text and email, { id } for select, multiple, offer and
plan, and { id, quantity } for quantity.
bundleoptionalobject
What the customer picked inside the bundle. Leave it out to let the widget
ask.
addonoptionalboolean
One-time products only. true adds the product as an add-on to a
subscription in the cart.
addonDurationoptionalnumber | null
One-time products only. How long the add-on runs: null is forever, 1 is
once.
giftCardoptionalobject | null
One-time products only. Gift card recipient, for gift card products with a
quantity of 1. All three keys must be present; each may be null.
productIdRequirednumber
ID of the variant, for a one-time product, or of the plan, for a
subscription.
quantityoptionalnumber
How many units to add.
metadataoptionalobject[] | null
Metafield values to store on the line.
idRequirednumber
ID of the metafield.
valuesRequiredobject[]
One entry per value: { id } when the metafield has preset values,
{ value } when the customer types the value.
optionsoptionalobject[] | null
Survey answers for the line.
addonoptionalboolean
true adds the product as an add-on. The cart must already hold a
subscription.
addonDurationoptionalnumber | null
How long the add-on runs: null is forever, 1 is once.
giftCardoptionalobject | null
Gift card recipient. Gift card products only, with a quantity of 1. All
three keys must be present; each may be null.
customerEmailRequiredstring | null
Email of the recipient.
customerNameRequiredstring | null
Name of the recipient.
messageRequiredstring | null
Message for the recipient.
bundleoptionalobject
What the customer picked inside the bundle.
idstring
ID of the cart, as a UUID.
shopIdnumber
ID of the shop the cart belongs to.
statusstring
initialized, abandoned, expired, completed or restored.
attachedboolean
true once a customer is attached to the cart.
currencyCodestring
Currency the cart is priced in, as an ISO 4217 code.
baseCurrencyCodestring
Default currency of the shop.
itemsCartItem[]
Lines in the cart. An item carries no money. The amounts are in
summaryItems, joined on summaryItems[].itemId === items[].id.
summaryItemsCartSummaryItem[]
Priced lines. This is where the money lives.
subTotalnumber
Cart total before discount and tax, in the minor unit.
discountTotalnumber
Discount across the cart, in the minor unit.
discountsCartDiscount[]
Every discount on the cart.
taxTotalnumber
Tax across the cart, in the minor unit.
taxRatenumber
Deprecated. Rates differ per line; read summaryItems[].taxRate.
customsFeenumber
Customs fee charged today, in the minor unit.
futureCustomsFeenumber
Customs fee on later shipments, in the minor unit.
adjustmentnumber
Top-up that lifts the payment to the minimum the gateway accepts.
totalnumber
Grand total across today's payment and the future one. This is not the
amount charged today.
balanceChangeobject
Change to the customer's store balance. Holds amount and currencyCode.
couponCodestring | null
Code of the applied coupon.
couponCoupon | null
The applied coupon. The widget always expands it.
giftCardCodestring | null
Code of the applied gift card.
giftCardGiftCard | null
The applied gift card. The widget always expands it.
giftInfoobject
Gift details of the cart. Always an object.
startsAtstring | null
Date the subscription starts, as YYYY-MM-DD.
referralIdnumber | null
ID of the referring customer.
onboardingTemplateIdnumber | null
ID of the onboarding template the cart follows.
customerIdnumber | null
ID of the attached customer.
customerobject | null
Guest details, before a customer is attached. null afterwards.
Where the order ships, or the pickup point the customer chose.
shippingAddressIdnumber | null
ID of the shipping address or of the pickup record.
billingAddressCustomerAddress | null
Billing address. Same fields as a delivery address.
billingAddressIdnumber | null
ID of the billing address.
shippingMethodShippingMethod | null
The chosen shipping method.
shippingMethodIdnumber | null
ID of the shipping method.
shippingCarrierShippingCarrier | null
The carrier that delivers the order. Holds id, name and serviceCodes.
shippingCarrierIdnumber | null
ID of the carrier.
shippingCarrierServicestring | null
Service code of the carrier, such as an express service.
paymentMethodPaymentMethod | null
The saved payment method on the cart. Only present for a signed-in customer.
paymentMethodIdnumber | null
ID of the payment method.
metadataMetafield[] | null
Metafields stored on the cart.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
quantityoptionalnumber
How many units the line holds.
optionsoptionalobject[] | null
Subscriptions and bundles. New survey answers for the line.
questionIdRequirednumber
ID of the question.
answersRequiredobject[]
The answers. The shape follows the question type: { content } for
text and email, { id } for select, multiple, offer and
plan, and { id, quantity } for quantity.
bundleoptionalobject
Bundles. What the customer picked inside the bundle.
itemsRequiredobject[]
The chosen products. Each has productId and quantity.
preferencesRequiredobject[]
The chosen preferences. Each has attributeId and values, an array of
attribute value IDs.
addonoptionalboolean
One-time products. true turns the line into an add-on.
addonDurationoptionalnumber | null
One-time products. How long the add-on runs: null is forever, 1 is once.
giftCardoptionalobject | null
One-time products. Gift card recipient. All three keys must be present; each
may be null.
customerEmailRequiredstring | null
Email of the recipient.
customerNameRequiredstring | null
Name of the recipient.
messageRequiredstring | null
Message for the recipient.
idstring
ID of the cart, as a UUID.
shopIdnumber
ID of the shop the cart belongs to.
statusstring
initialized, abandoned, expired, completed or restored.
attachedboolean
true once a customer is attached to the cart.
currencyCodestring
Currency the cart is priced in, as an ISO 4217 code.
baseCurrencyCodestring
Default currency of the shop.
itemsCartItem[]
Lines in the cart. An item carries no money. The amounts are in
summaryItems, joined on summaryItems[].itemId === items[].id.
summaryItemsCartSummaryItem[]
Priced lines. This is where the money lives.
subTotalnumber
Cart total before discount and tax, in the minor unit.
discountTotalnumber
Discount across the cart, in the minor unit.
discountsCartDiscount[]
Every discount on the cart.
taxTotalnumber
Tax across the cart, in the minor unit.
taxRatenumber
Deprecated. Rates differ per line; read summaryItems[].taxRate.
customsFeenumber
Customs fee charged today, in the minor unit.
futureCustomsFeenumber
Customs fee on later shipments, in the minor unit.
adjustmentnumber
Top-up that lifts the payment to the minimum the gateway accepts.
totalnumber
Grand total across today's payment and the future one. This is not the
amount charged today.
balanceChangeobject
Change to the customer's store balance. Holds amount and currencyCode.
couponCodestring | null
Code of the applied coupon.
couponCoupon | null
The applied coupon. The widget always expands it.
giftCardCodestring | null
Code of the applied gift card.
giftCardGiftCard | null
The applied gift card. The widget always expands it.
giftInfoobject
Gift details of the cart. Always an object.
startsAtstring | null
Date the subscription starts, as YYYY-MM-DD.
referralIdnumber | null
ID of the referring customer.
onboardingTemplateIdnumber | null
ID of the onboarding template the cart follows.
customerIdnumber | null
ID of the attached customer.
customerobject | null
Guest details, before a customer is attached. null afterwards.
What the address form does when the street number is missing. Default
null, which is no check.
removeTrailingZeroesoptionalboolean | null
true prints £10 instead of £10.00. Default null.
itemAddedScreenoptionalboolean
Deprecated. afterItemAdded replaces it.
accentColoroptionalstring | null
Accent colour, as CSS. It sets --accent. Without it the widget uses the
shop's brand colour.
backgroundColoroptionalstring | null
Colour of the backdrop behind the widget. Sets --backdrop-bg.
widgetBackgroundColoroptionalstring | null
Background of the widget. Sets --widget-bg.
widgetBackgroundDarkeroptionalstring | null
Second colour of the widget background. Set it to make the background a
gradient, and it also becomes the footer background.
fontStyleoptionalstring | null
Name of a Google Fonts family. The widget loads the family and sets
--font-primary.
fontColorPrimaryoptionalstring | null
Main text colour. Sets --font-color-primary.
fontColorSecondaryoptionalstring | null
Secondary text colour. Sets --font-color-secondary.
logoUrloptionalstring | null
Logo shown in the widget header.
buttonStyleoptionalnumber | null
Corner radius of the buttons, in pixels. Sets --button-border-radius.
cardStyleoptionalnumber | null
Corner radius of the cards, in pixels. Sets --card-border-radius.
cardBackgroundColoroptionalstring | null
Background of the cards. Sets --card-bg, and the widget computes
--control-hover-bg from it.
cardBorderColoroptionalstring | null
Border colour of the cards. Sets --card-border-color.
cardDividerColoroptionalstring | null
Colour of the dividers inside a card. Sets --card-divider-color.
headerHeightoptionalnumber | null
Height of the header, in pixels. Sets --header-height.
headerBackgroundColoroptionalstring | null
Background of the header. Sets --header-bg. Without it the widget
background is used.
headerFontColoroptionalstring | null
Text colour in the header. Sets --header-font-color.
footerBackgroundoptionalstring | null
Background of the footer. Sets --footer-bg.
footerFontColoroptionalstring | null
Text colour in the footer. Sets --footer-font-color.
inputBackgroundoptionalstring | null
Background of the form fields. Sets --input-bg.
inputBorderColoroptionalstring | null
Border colour of the form fields. Sets --input-border-color.
inputFontColoroptionalstring | null
Text colour in the form fields. Sets --input-font-color.
segmentControlBackgroundoptionalstring | null
Background of the segmented controls. Sets --segment-control-bg.
emailRequiredstring
Email address for the checkout field.
marketingConsentoptionalboolean
true ticks the marketing opt-in.
tosConsentoptionalboolean
true ticks the terms checkbox.
checkoutUrloptionalstring
Page on your site that owns the checkout. The widget sends the customer
here instead of opening its own checkout. It accepts /checkout and
/checkout/{cartId}; a plain path gets the current cart ID appended.
cartSummaryUrloptionalstring
Page on your site that owns the cart summary. It behaves like
checkoutUrl.
disableUrlsoptionalstring[]
Paths on which the widget stands down. * matches inside one path
segment and ** across segments. An entry without a wildcard also
matches on a segment boundary, so /checkout covers
/checkout/success but not /checkout-foo. Only the pathname is
matched, case-insensitively; the query and the hash are ignored.
brandColourstring | null
Brand colour. The widget uses it as the accent when no accent colour is set.
faviconstring | null
Favicon URL.
logoSquarestring | null
Square logo URL.
namestring
Name of the currency.
symbolstring
Symbol of the currency.
htmlstring
HTML entity of the symbol.
abbreviationstring
ISO 4217 code. Pass this to setCurrency.
gatewaysShopGateway[]
Payment gateways that take this currency. Each has name (stripe,
braintree, paypal or authorize_net), type (card or paypal)
and connectable, whose keys depend on the gateway: Stripe has
isoCountryCode and publishableKey, Braintree has authorizeKey and
paypal, PayPal has clientId and merchantId, and Authorize.Net has
apiLoginId, publicKey and sandbox.
codestring
Two-letter code. Pass this to setLanguage.
namestring
Name of the language.
primaryboolean
true on the shop's main language.
publishedboolean
true when customers can pick it.
currencyPositionnumber
1 puts the currency symbol before the amount, 0 after it.
dictionaryobject
Translations the widget uses, keyed by section and then by phrase.
checkoutWidgetboolean
The widget itself.
configurableBundlesboolean
Bundles the customer builds.
embedCheckoutboolean
Checkout inside the widget.
onboardingTemplatesboolean
Onboarding templates.
outOfStockboolean
Out-of-stock handling.
whiteLabelingboolean
Subbly branding removed.
allowCheckoutDiscountsboolean
Discount fields are shown at checkout.
allowCouponDiscountboolean
Coupons are accepted.
allowGiftCardDiscountboolean
Gift cards are accepted.
allowMultipleSubscriptionsboolean
A customer can hold more than one subscription.
applePayboolean
Apple Pay is offered.
googlePayboolean
Google Pay is offered.
stripeLinkboolean
Stripe Link is offered.
cancellationRequestEnabledboolean
Customers can ask to cancel.
cancellationTypestring
immediate or end_of_period.
collectBillingAddressboolean
Checkout asks for a billing address.
collectBuyerNameboolean
Checkout asks for the buyer's name.
collectCompanyNameboolean
Checkout asks for a company name.
collectGiftRecipientEmailboolean
Checkout asks for the recipient's email on a gift.
displayCommitmentAndTrialboolean
Commitment and trial terms are shown.
facebookConversionEnabledboolean
Facebook conversion tracking is on.
tiktokConversionEnabledboolean
TikTok conversion tracking is on.
giftDurationEnabledboolean
The buyer picks how long a gift runs.
giftStartDateEnabledboolean
The buyer picks the gift start date.
groupProductVariantsboolean
Variants are grouped in the widget.
lastPaymentMethodDetachmentEnabledboolean
The last payment method can be removed.
limitCouponAndReferralDiscountboolean
A coupon and a referral discount cannot stack.
localPickupOnlyboolean
Only local pickup is offered.
marketingConsentRequiredboolean
Marketing consent is required.
tosConsentRequiredboolean
Terms consent is required.
outOfStockEnabledboolean
Out-of-stock products stay visible.
phoneNumberOptionalboolean
The phone number is optional.
registerWithoutPasswordboolean
Customers sign up without a password.
scaEnabledboolean
Strong customer authentication is on.
skipPaymentMethodWithGiftCardboolean
A gift card that covers the cart skips the payment method.
subscriptionAddonsboolean
Add-ons can join a subscription.
subscriptionQuantitySelectorboolean
The quantity selector is shown on subscriptions.
subscriptionStartDateEnabledboolean
The customer picks the start date.
syncOrdersPreferencesOnSubscriptionUpdateboolean
Open orders follow a subscription change.
taxEnabledboolean
Tax is calculated.
taxInclusiveboolean
Prices hold the tax.
zeroChargeNotificationboolean
The customer is told when today's charge is zero.
dimensionUnitstring
cm or in.
weightUnitstring
lb, oz, g or kg.
timezonestring | null
Timezone of the shop.
stripePaymentMethodTypesstring[]
Stripe payment method types the shop accepts.
startsAtRequiredstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersRequirednumber | null
How many orders the gift covers.
messageRequiredstring | null
Message for the recipient.
recipientEmailRequiredstring | null
Email of the recipient.
emailoptionalstring
Email address.
firstNameoptionalstring
First name.
lastNameoptionalstring
Last name.
marketingConsentoptionalboolean
true when the guest opts into marketing.
tosConsentoptionalboolean
true when the guest accepts the terms. The cart reads this back as the date tosConsentAt.
externalIdoptionalstring | null
Your own ID for the customer.
firstNameRequiredstring
First name.
lastNameRequiredstring
Last name.
addressOneRequiredstring
Street and number.
addressTwoRequiredstring | null
Second address line. The key must be present; the value may be null.
cityRequiredstring
City.
zipRequiredstring
Postal code.
countryIdRequirednumber
ID of the country, from subblyCart.shop.shippingCountries.
phoneoptionalstring
Phone number.
companyNameoptionalstring | null
Company name.
regionoptionalstring
Region name.
regionIdoptionalnumber
ID of the region, from the country's regions.
firstNameRequiredstring
First name.
lastNameRequiredstring
Last name.
addressOneRequiredstring
Street and number.
addressTwoRequiredstring | null
Second address line. The key must be present; the value may be null.
cityRequiredstring
City.
zipRequiredstring
Postal code.
countryIdRequirednumber
ID of the country.
phoneoptionalstring
Phone number.
companyNameoptionalstring | null
Company name.
regionoptionalstring
Region name.
regionIdoptionalnumber
ID of the region.
firstNameRequiredstring
First name.
lastNameRequiredstring
Last name.
phoneRequiredstring
Phone number.
pickupPointTypeoptionalstring
Only mondial_relay.
pickupPointIdoptionalstring
ID of the pickup point at the carrier.
idRequirednumber
ID of the metafield.
valuesRequiredobject[]
One entry per value: { id } when the metafield has preset values,
{ value } when the customer types the value.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
itemsRequiredobject[]
The chosen products. Each has productId and quantity.
preferencesRequiredobject[]
The chosen preferences. Each has attributeId and values, an array of
attribute value IDs.
customerEmailRequiredstring | null
Email of the recipient.
customerNameRequiredstring | null
Name of the recipient.
messageRequiredstring | null
Message for the recipient.
questionIdRequirednumber
ID of the question.
answersRequiredobject[]
The answers. The shape follows the question type: { content } for
text and email, { id } for select, multiple, offer and
plan, and { id, quantity } for quantity.
itemsRequiredobject[]
The chosen products. Each has productId and quantity.
preferencesRequiredobject[]
The chosen preferences. Each has attributeId and values, an array
of attribute value IDs.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idstring
ID of the line, as a UUID. Pass it to updateItem and removeItem.
typestring
one_time or subscription.
productIdnumber
ID of the variant on a one-time item, or of the plan on a subscription.
statusstring
active, unavailable or out_of_stock.
productProductVariant | ProductPlan | null
The variant or plan the line points at. The widget always expands it.
productNamestring
Name of the product, as it is shown in the cart.
descriptionstring
Line description, such as the plan name.
quantitynumber
How many units the line holds.
addonboolean
true when the line is an add-on to a subscription in the same cart.
addonDurationnumber | null
How long the add-on runs. null is forever, 1 is once.
amountOffnumber | null
Fixed discount on the line, in the minor unit.
percentOffnumber | null
Percentage discount on the line.
giftCardobject
Gift card recipient. Always an object; the members are null when the
line is not a gift card.
bundleobject
Contents of the bundle. items is empty when the line is not a bundle.
optionsSubscriptionSurvey | null
Survey answers for the line. Always null on a one-time item.
metadataMetafield[] | null
Metafields stored on the line.
originstring | null
How the line got into the cart: pre_purchase, mid_purchase,
post_purchase, coupon, or null when the customer added it.
createdAtstring
Creation date, as an ISO 8601 string.
updatedAtstring
Last change date, as an ISO 8601 string.
itemIdstring | null
ID of the cart item this amount belongs to. null on the shipping line.
typestring
one_time, subscription, trial_first, gift_card, setup_fee,
survey, shipping or addon.
productIdnumber | null
ID of the variant or plan. null on the shipping line.
quantitynumber
How many units are priced.
pricenumber | null
Unit price in the minor unit. null for a dynamic-price bundle with no
items yet.
totalnumber
Line total after discount and tax.
subTotalnumber
Line total before discount and tax.
taxAmountnumber
Tax on the line, in the minor unit.
taxRatenumber
Tax rate applied to the line.
taxInclusiveboolean
true when the price already holds the tax.
discountnumber | null
Discount on the line, in the minor unit.
discountsobject[]
Every discount on the line. Each has type, description, total and,
sometimes, chargeNow.
chargeNowboolean
true when the line is part of today's payment.
bundleobject | null
Priced bundle contents. null on setup_fee, survey and shipping
lines. Holds items, where each entry has itemId, productId,
variantId, quantity, quantityTotal, price, subTotal, total,
taxAmount, taxRate, taxInclusive, discount and discounts.
subscriptionobject | null
Schedule of a subscription line. Non-null only on subscription and
trial_first lines. Holds firstPaymentAt, nextPaymentAt,
numberOfShipments and firstShipmentAt.
typestring
coupon, coupon_gift_offer, offer, referral, balance,
gift_card or bundle.
descriptionstring
Text shown next to the discount.
totalnumber
Amount taken off, in the minor unit.
chargeNowboolean
true when the discount applies to today's payment.
idnumber
ID of the coupon.
couponIdstring
The code the customer types.
namestring
Name of the coupon.
amountOffnumber | null
Fixed discount, in the minor unit.
percentOffnumber | null
Percentage discount.
durationstring
once, forever or multiple.
durationInMonthsnumber | null
Months the discount runs, when duration is multiple.
behaviorobject
Holds skipPaymentMethodAllowed, true when the coupon lets the customer check out without a payment method.
giftobject | null
Gift offer attached to the coupon. Holds addonDuration (once or forever), amountOff and percentOff.
idnumber
ID of the gift card.
codestring
The code the customer types.
amountnumber
Face value, in the minor unit.
balancenumber
Value left, in the minor unit.
messagestring
Message written on the card.
statusstring
issued, redeemed, partially_used, used, cancelled or expired.
startsAtstring | null
Date the gift starts, as YYYY-MM-DD.
numberOfOrdersnumber | null
How many orders the gift covers.
messagestring | null
Message for the recipient.
recipientEmailstring | null
Email of the recipient.
idnull
Always null on a guest.
userIdnull
Always null on a guest.
createdAtnull
Always null on a guest.
activeSubscriptionsCountnumber
Always 0 on a guest.
firstNamestring | null
First name.
lastNamestring | null
Last name.
emailstring | null
Email address.
marketingConsentboolean | null
true when the guest opted into marketing.
tosConsentAtstring | null
Date the guest accepted the terms, as an ISO 8601 string.
externalIdstring | null
Your own ID for the customer.
idnumber
ID of the address.
firstNamestring
First name.
lastNamestring
Last name.
companyNamestring | null
Company name.
addressOnestring
Street and number.
addressTwostring | null
Second address line.
citystring
City.
zipstring
Postal code.
regionstring
Region name.
regionIdnumber | null
ID of the region.
countrystring
Country name.
countryIdnumber
ID of the country.
countryCodestring
Two-letter country code.
phonestring
Phone number.
idnumber
ID of the pickup record.
firstNamestring
First name.
lastNamestring
Last name.
phonestring
Phone number.
pickupPointobject | null
The point itself: id, externalId, address1, address2, city,
zip, countryId, countryCode, type (mondial_relay),
createdAt and updatedAt.
idnumber
ID of the method.
typestring
shipping_option, local_delivery or local_pickup.
shippingFeenumber
Fee charged today, in the minor unit.
futureShippingFeenumber
Fee on later shipments, in the minor unit.
prohibitedProductsnumber[]
IDs of products the method cannot carry.
methodobject
Details of the method. A shipping_option has duration, name and
type (flat_price, product, price, weight or dynamic); a
local_delivery has comment, duration and name; a local_pickup
holds the pickup point.
carrierShippingCarrier | null
shipping_option only. The carrier: id, name and serviceCodes.
carrierIdnumber | null
shipping_option only. ID of the carrier.
servicestring | null
shipping_option only. Carrier service code.
customsFeenumber
shipping_option only. Customs fee charged today.
futureCustomsFeenumber
shipping_option only. Customs fee on later shipments.
Card details: brand, lastFour, expiryMonth, expiryYear and type.
usBankAccountobject | null
Bank details: accountHolderType, accountType, bankName, email, last4, name and routingNumber.
acssDebitobject | null
Canadian debit details: email, name, bankName, lastFour, institutionNumber and transitNumber.
bancontactobject | null
Holds email and name.
cashappobject | null
Holds email, name, buyerId and cashTag.
idealobject | null
Holds bank, bic, email and name.
linkobject | null
Holds email and name.
sepaDebitobject | null
Holds bank_code, branch_code, country, email, ibanLast4 and name. These are the only snake_case keys in the API.
sofortobject | null
Holds country, email and name.
idnumber
ID of the stored value set.
metadataIdnumber
ID of the metafield definition.
namestring
Name of the metafield.
slugstring
Slug of the metafield.
descriptionstring | null
Description shown to the customer.
unitstring | null
Unit of the value.
accessLevelstring
private or storefront.
dataTypestring
single_line_string, multi_line_text, rich_text, integer,
decimal, datetime, date, time, volume, weight, boolean,
color, rating, url, money or json.
saveBehaviorstring
customer or subscription.
editableboolean
true when the customer can change the value.
multipleboolean
true when the metafield takes several values.
presetboolean
true when the values come from a fixed list.
variantboolean
true when the metafield varies per variant.
valuesobject[]
The stored values. Each has id, value (always a string, whatever
dataType says), valueId and metadata, an object with imageUrl
and color.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
idnumber
ID of the variant.
namestring
Name of the variant.
descriptionstring | null
Description of the variant.
pricenumber
Price in the minor unit of the currency, such as cents.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the variant is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing: id, type and ranges, where each range is id, amount and range.
optionsobject[]
Variant options. Each has id, name and value.
attributesMetafield[]
Variant attributes, shaped like metadata.
metadataMetafield[] | null
Metafields of the variant.
parentProductOneTime
The product the variant belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the plan.
namestring
Name of the plan.
descriptionstring | null
Description of the plan.
pricingNamestring | null
Name of the pricing the plan belongs to.
planHashstring | null
Hash that identifies the plan in checkout links.
pricenumber
Price per billing period, in the minor unit.
setupFeenumber | null
One-off fee charged with the first payment.
trialLengthnumber | null
Trial length in billing periods.
trialLengthDaysnumber | null
Trial length in days.
trialPricenumber | null
Price of the trial.
frequencyCountnumber
How many frequency units sit between two payments.
frequencyUnitstring
day, week or month.
commitmentBillingCountnumber
Payments the customer commits to.
chargesLimitnumber | null
Total payments before the subscription ends.
chargeImmediatelyboolean
true when the first payment is taken at checkout.
shipImmediatelyboolean
true when the first shipment goes out at once.
shippingsobject[]
Shipment schedule. Each entry has id, shippingAt, addCount, addUnit, createdAt and updatedAt.
cutOffAtstring | null
Date the current shipment window closes.
preOrderEndAtstring | null
Date the pre-order window closes.
rebillingStartAtstring | null
Date recurring billing starts.
stockCountnumber | null
Units left, or null when stock is not tracked.
bundlePlanIdnumber | null
ID of the bundle plan, when the plan is sold inside a bundle.
priceSchemeobject | null
Quantity-based pricing, shaped as on a variant.
surveySurvey | null
Survey the customer fills in for this plan.
metadataMetafield[] | null
Metafields of the plan.
parentProductSubscription
The product the plan belongs to.
createdAtstring
Creation date, as an ISO 8601 string.
idnumber
ID of the product.
typestring
one_time or subscription.
namestring
Name of the product.
slugstring
Slug of the product.
descriptionstring | null
Description of the product.
deliveryInfostring | null
Delivery text shown in the widget.
digitalboolean
true when the product needs no shipping.
giftingEnabledboolean
true when the product can be bought as a gift.
collectShippingAddressboolean
true when checkout asks for a shipping address.
imagesobject[]
Product images. Each has id, url, order, createdAt and updatedAt.
bundleBundle | null
The bundle the product builds, when it is a bundle product.
bundleIdnumber | null
ID of that bundle.
bundleRulesetIdnumber | null
ID of the ruleset the bundle follows.
metadataMetafield[] | null
Metafields of the product.
createdAtstring
Creation date, as an ISO 8601 string.
giftCardboolean
One-time products only. true when the product is a gift card.
giftCardExpirationnumber | null
One-time products only. Days until the gift card expires.
optionsobject[]
One-time products only. Each option has id, name and values.
variantsProductVariant[]
One-time products only. Every variant of the product.
setupFeenumber
Subscription products only. Default setup fee.
preOrderEndAtstring | null
Subscription products only. Date the pre-order window closes.
plansProductPlan[]
Subscription products only. Every plan of the product. pricings is a deprecated alias.
customerEmailstring | null
Email of the recipient.
customerNamestring | null
Name of the recipient.
messagestring | null
Message for the recipient.
itemsBundleItem[]
Products inside the bundle. Each has id, productId, product
(a ProductVariant), quantity, extraPrice, position,
stockCount, settings, createdAt and updatedAt.
preferencesobject[]
Bundle preferences. Each has attributeId and values, an array of
attribute value IDs.
surveyIdnumber
ID of the survey.
itemsCountnumber
How many products the answers select.
dataobject[]
The answers. Each entry has questionId and answers, an array of
{ content }, { id } or { id, quantity } objects.
itemsobject[]
Products the answers resolve to. Each has id, productId and surveyId.
