# Ordergroove Developer Platform Developer Platform Build subscription commerce\ that scales. ============ Complete REST and GraphQL APIs and implementation guides for developers building on the world's most advanced subscription commerce platform. #### [Developer Guides](/docs) Platform fundamentals, integration patterns, and step-by-step implementation walkthroughs for every part of the subscription lifecycle. #### [API Reference](/reference) Comprehensive REST and GraphQL reference with live examples, request builders, and full schema documentation for every endpoint. #### [GraphQL](/graphql/introduction) Fetch subscriptions, orders, and all their related data in a single request — query exactly the fields you need with Ordergroove's read-only GraphQL API. > APIs, SDKs, and guides for building subscription commerce with Ordergroove. ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ordergroove.com/_mcp/server ## Docs - [Platform overview](https://developer.ordergroove.com/docs/developer-fundamentals/platform-overview/developer-fundamentals.md): Developer fundamentals for building on Ordergroove. - [Systems landscape map](https://developer.ordergroove.com/docs/developer-fundamentals/platform-overview/systems-landscape-map.md): The six integration components that power Ordergroove. - [Data model at a glance](https://developer.ordergroove.com/docs/developer-fundamentals/platform-overview/data-model-at-a-glance.md): The four core objects that power Ordergroove. - [Subscription Manager Tagging and Authentication](https://developer.ordergroove.com/docs/developer-fundamentals/platform-overview/subscription-manager-tagging-and-authentication.md) - [Customer and Payment Updates](https://developer.ordergroove.com/docs/developer-fundamentals/platform-overview/customer-and-payment-updates.md) - [Setting up a Sandbox Store](https://developer.ordergroove.com/getting-started/sandbox-store.md): Set up a Shopify developer store, install Ordergroove, and run through the full subscription lifecycle - [Custom Platform and Headless Subscription Implementation](https://developer.ordergroove.com/getting-started/headless-implementation.md): Read customer selections and manage cart state in headless environments - [Installing Ordergroove with App Embed](https://developer.ordergroove.com/getting-started/app-embed.md): Set up Ordergroove on your theme without injecting code directly into theme files - [Install Ordergroove on an Online Store 2.0 Theme](https://developer.ordergroove.com/getting-started/os2-theme.md): Add Ordergroove offer and Subscription Manager blocks via the Shopify theme editor - [Removing Ordergroove Code from Your Shopify Theme](https://developer.ordergroove.com/getting-started/remove-shopify-code.md): General guidelines for removing Ordergroove assets and code snippets from your Shopify theme - [General FAQ](https://developer.ordergroove.com/getting-started/faq.md): Common questions about the Ordergroove API and platform - [Offer Tagging](https://developer.ordergroove.com/lifecycle/enrollment/offer-tagging.md): Place Ordergroove subscription offers on your storefront using the og-offer element - [Tagging the Product Details Page (PDP)](https://developer.ordergroove.com/lifecycle/enrollment/pdp-tagging.md): Add Ordergroove's subscription offer snippet to your Shopify product page - [Cart Opt-In Tagging](https://developer.ordergroove.com/lifecycle/enrollment/cart-opt-in.md): Implement Ordergroove Cart Opt-In on your Shopify theme - [Subscription Creation via Purchase POST](https://developer.ordergroove.com/lifecycle/enrollment/purchase-post.md): Notify Ordergroove of each checkout to create subscriptions and log cart sessions - [Add a Subscription to Cart](https://developer.ordergroove.com/lifecycle/enrollment/add-to-cart.md): Use og-offer components and CSS variables to build a custom subscription enrollment UI - [Troubleshooting Cart Offers](https://developer.ordergroove.com/lifecycle/enrollment/troubleshooting-cart.md): Diagnose and resolve common issues with Ordergroove cart enrollment offers - [Offer Code Elements](https://developer.ordergroove.com/lifecycle/enrollment/offer-code-elements.md): Reference for Ordergroove web component elements and their attributes and slots - [Domain Objects](https://developer.ordergroove.com/lifecycle/enrollment/domain-objects.md): Reference for core data types used in Ordergroove offer elements - [Helper Methods](https://developer.ordergroove.com/lifecycle/enrollment/helper-methods.md): Global helper methods available via the og.offers library - [Showing Discounted Price](https://developer.ordergroove.com/lifecycle/enrollment/discounted-price.md): Surface the subscription discount price outside of Ordergroove's offer widget in your Shopify theme - [Customizing the Initial Offer Incentive (IOI)](https://developer.ordergroove.com/lifecycle/enrollment/ioi.md): Use Shopify Functions to create a custom discount experience for initial subscription orders - [Real Time Stock Update](https://developer.ordergroove.com/lifecycle/enrollment/stock-update.md): Use the Ordergroove API to update product stock status in real time - [Add a subscription offer to quickview, homepage, or other areas of your site](https://developer.ordergroove.com/lifecycle/enrollment/additional-areas.md): Display Ordergroove offers outside the standard PDP using the data-shopify-product-handle attribute - [Tracking Affiliate Codes on Recurring Orders](https://developer.ordergroove.com/lifecycle/enrollment/affiliate-codes.md): Reference initial order data on recurring subscription orders to track affiliate codes and similar attribution - [Advanced Offer Customizations & FAQ](https://developer.ordergroove.com/lifecycle/enrollment/advanced-customizations.md): Custom HTML and CSS patterns for offer components, plus answers to common template questions - [Modify a subscription from email and SMS](https://developer.ordergroove.com/lifecycle/enrollment/email-sms.md): Use 1-Click action URLs to let customers manage subscriptions directly from email and SMS messages - [First Order Place Date control for Shopify Merchants](https://developer.ordergroove.com/lifecycle/enrollment/shopify-first-order.md): Use line item properties to control when the first recurring subscription order is placed - [Free shipping on initial orders](https://developer.ordergroove.com/lifecycle/enrollment/free-shipping.md): Use Shopify Functions to offer free shipping when customers first purchase a subscription - [Subscription Manager From The Customer's Perspective](https://developer.ordergroove.com/lifecycle/sm/customer-overview.md): A tour of the customer-facing Subscription Manager experience - [Tour of Subscription Manager v25](https://developer.ordergroove.com/lifecycle/sm/tour-v25.md): Folder structure, file organization, and navigation tips for developers customizing the SM base template - [Intro to v25 for Developers Transitioning from v0](https://developer.ordergroove.com/lifecycle/sm/v25-transition.md): Key differences between the v0 and v25 Subscription Manager templates and how to migrate your customizations - [Subscription Manager File Descriptions](https://developer.ordergroove.com/lifecycle/sm/file-descriptions.md): A reference guide to every file in the Subscription Manager template and what it controls - [Loading the Subscription Manager inside a Single-Page App](https://developer.ordergroove.com/lifecycle/sm/spa-loading.md): Prevent stale data and re-firing notifications when navigating in React and other SPAs - [Developing for Subscription Manager Overview](https://developer.ordergroove.com/lifecycle/sm/dev-overview.md): Links to the key guides you need to get up and running with Subscription Manager development - [Convert your customers/account page to support Online Store 2.0](https://developer.ordergroove.com/lifecycle/sm/os2-conversion.md): Modify your Shopify theme to support blocks on the customers/account page and add the Subscription Manager - [Tagging the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/tagging.md): Add a link to the Ordergroove Subscription Manager on your Shopify customers/account page - [Integrating External APIs in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/external-apis.md): Dynamically pull in data from external APIs and render it within the Subscription Manager - [Calling Ordergroove's REST APIs from within Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/rest-apis.md): Options for making authenticated REST API calls from the Subscription Manager using Storefront Auth - [Preserve Analytics Tracking while Customizing Subscription Manager Templates](https://developer.ordergroove.com/lifecycle/sm/analytics-tracking.md): How Subscription Manager front-end tracking works and what to avoid when customizing your template - [Understanding Subscription Manager Custom Elements](https://developer.ordergroove.com/lifecycle/sm/custom-elements.md): How the key custom elements in the v25 template work and how to use them - [Edit Code with the Advanced Editor](https://developer.ordergroove.com/lifecycle/sm/advanced-editor.md): Navigate files, edit templates and scripts, and work with syntax highlighting in the Ordergroove advanced editor - [Subscription Manager Theme Editor Overview](https://developer.ordergroove.com/lifecycle/sm/theme-editor.md): Navigate the landing page, choose between Basic and Advanced modes, and manage your SM themes - [Subscription Manager Development Guide](https://developer.ordergroove.com/lifecycle/sm/dev-guide.md): Nunjucks templating, lit-html expressions, filters, objects, and common pitfalls for SM customization - [Customizing Subscription Manager Sections on Shopify](https://developer.ordergroove.com/lifecycle/sm/shopify-sections.md): Use CSS classes to style the Main Body and Payment Update sections of the Subscription Manager - [Refreshing Data in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/refreshing-data.md): How to update the Subscription Manager display after making custom changes to orders or subscriptions - [Objects](https://developer.ordergroove.com/lifecycle/sm/objects.md): An introduction to global and scoped objects in the Subscription Manager and how to use them - [Object Reference](https://developer.ordergroove.com/lifecycle/sm/object-reference.md): A complete reference for all objects available in Subscription Manager templates - [Translations](https://developer.ordergroove.com/lifecycle/sm/translations.md): Serve the Subscription Manager in multiple languages using Ordergroove's built-in i18n support - [Subscription Manager Local Development](https://developer.ordergroove.com/lifecycle/sm/local-development.md): Use smi-serve to develop your Subscription Manager theme locally with source control and CLI deployment - [Debugging with Redux](https://developer.ordergroove.com/lifecycle/sm/redux-debugging.md): Use Redux DevTools to inspect the Subscription Manager state and debug custom changes - [Working with Dates in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/dates.md): Use the date filter and dayjs to format and compute dates in your Subscription Manager templates - [Adding a Scrollbar to Inactive Subscriptions in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/scrollbar.md): Add a scrollbar to the Inactive Subscriptions section in v0 to prevent page scrolling - [One Time SKU Swap Configuration in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/sku-swap.md): Allow customers to swap their product for a single upcoming order without permanently changing their subscription - [Dynamic Shipping Restrictions in the Subscription Manager](https://developer.ordergroove.com/lifecycle/sm/shipping-restrictions.md): Restrict which states are available when customers edit their subscription shipping address - [Limiting Future Dates in the Change Date Calendar](https://developer.ordergroove.com/lifecycle/sm/limit-dates.md): Control how far into the future customers can set upcoming subscription order dates - [Customizing Calendars and Dates in v25](https://developer.ordergroove.com/lifecycle/sm/calendars-dates.md): Use the cally and dayjs libraries to customize datepicker behavior and date formatting in the Subscription Manager - [Adding a Cancel Button to Modals](https://developer.ordergroove.com/lifecycle/sm/cancel-button.md): Add a dedicated Cancel button to Subscription Manager pop-up modals for improved user experience - [Embedding Cancel Flows on Headless & Custom Subscription Pages](https://developer.ordergroove.com/lifecycle/sm/cancel-flow-headless.md): Mount Ordergroove's cancel flow on a subscription management page that isn't built with Subscription Manager templates - [Customizing Cancel Flow Styling](https://developer.ordergroove.com/lifecycle/sm/cancel-flow-styling.md): Theme Ordergroove's cancel flow with CSS custom properties, on Subscription Manager or on a headless page - [Updating your Subscription Manager theme to support cancel flows](https://developer.ordergroove.com/lifecycle/sm/cancel-flow-theme-update.md): Let your live theme open cancel flows, with an automatic upgrade or by editing the templates yourself - [Implementing Country & State Dropdown in Subscription Manager Themes](https://developer.ordergroove.com/lifecycle/sm/country-state.md): Add a country/state dropdown to the shipping address form to reduce typos and improve the customer experience - [Modify the Change Billing Process Button](https://developer.ordergroove.com/lifecycle/sm/billing-button.md): Move the Change Billing button inside the Subscription Manager for consistent styling on Shopify - [Enabling Payment Updates for Shopify New Accounts](https://developer.ordergroove.com/lifecycle/sm/shopify-payment-updates.md): Update your Subscription Manager to send customers to Shopify's customer accounts interface to update their payments instead of sending an email - [Routing the Update payment link to Frictionless Payments](https://developer.ordergroove.com/lifecycle/sm/frictionless-payments.md): Override the Subscription Manager's payment details template so the Update payment link opens your Frictionless Payments page - [Subscription Manager Templates Changelog](https://developer.ordergroove.com/lifecycle/sm/templates-changelog.md): A list of changes in Ordergroove's Subscription Manager templates - [Cancel Flows Changelog](https://developer.ordergroove.com/lifecycle/sm/cancel-flows-changelog.md): A list of changes in Ordergroove's cancel flows - [Legacy Subscription Manager v0 Components & Containers](https://developer.ordergroove.com/lifecycle/v0/overview.md): An overview of the liquid file structure of the Subscription Manager and where components and containers can be modified or restyled - [Subscription Manager Templates](https://developer.ordergroove.com/lifecycle/v0/templates.md): A reference for all available templates and their purpose in the legacy Subscription Manager v0 - [Orders Unsent Section](https://developer.ordergroove.com/lifecycle/v0/orders-unsent.md): An overview of the order-unsent.liquid file structure and its components - [Skip Order](https://developer.ordergroove.com/lifecycle/v0/skip-order.md): An overview of the skip order component in the legacy Subscription Manager v0 - [Send Now](https://developer.ordergroove.com/lifecycle/v0/send-now.md): An overview of the send now component in the legacy Subscription Manager v0 - [Change Date](https://developer.ordergroove.com/lifecycle/v0/change-date.md): An overview of the change date component in the legacy Subscription Manager v0 - [Orders Processing Section](https://developer.ordergroove.com/lifecycle/v0/orders-processing.md): An overview of the orders-processing.liquid file structure and its components - [Inactive Subscriptions Section](https://developer.ordergroove.com/lifecycle/v0/inactive-subscriptions.md): An overview of the inactive-subscriptions.liquid file structure and its components - [Recurring Order Placement](https://developer.ordergroove.com/lifecycle/order/recurring-placement.md): Implement recurring order placement for subscription orders using Ordergroove's XML-based API or batch methods - [Instant Upsell Overview](https://developer.ordergroove.com/lifecycle/order/instant-upsell.md): Allow existing subscribers to add items to their upcoming subscription orders as a one-time delivery or new subscription - [Instant Upsell through API](https://developer.ordergroove.com/lifecycle/order/instant-upsell-api.md): Add items to upcoming subscription orders via API, bypassing the onsite checkout flow - [1-Click Actions in Emails](https://developer.ordergroove.com/lifecycle/order/1-click-emails.md): Redirect customers to a location of your choice using 1-Click URLs in emails to delay or cancel future shipments - [Using Webhooks for 1-Click Actions](https://developer.ordergroove.com/lifecycle/order/webhooks-1-click.md): Let subscribers manage their subscriptions directly from emails using 1-click action URLs powered by webhooks - [Configuring PayPal](https://developer.ordergroove.com/lifecycle/order/paypal.md): Use PayPal as a payment method with Ordergroove's subscription and payment update APIs - [Product Feed](https://developer.ordergroove.com/data/product-feed.md): Keep Ordergroove in sync with your product catalog via recurring SFTP file delivery - [Sync Ordergroove Data into Internal Systems](https://developer.ordergroove.com/data/sync-internal.md): Best practices for building a reliable pipeline to extract Ordergroove data into your data warehouse or external systems - [Implement Custom Data Pipelines](https://developer.ordergroove.com/data/custom-pipelines.md): Set up custom data pipelines to sync Ordergroove data into your warehouse using Ordergroove REST APIs - [Using Prebuilt Connectors](https://developer.ordergroove.com/data/prebuilt-connectors.md): Quickly sync Ordergroove data using third-party managed connectors instead of building a custom ETL pipeline - [SFTP File Drops](https://developer.ordergroove.com/data/sftp.md): Sync Ordergroove data using scheduled daily export files delivered via SFTP - [Sync Events](https://developer.ordergroove.com/data/sync-events.md): Track real-time changes in your Ordergroove program using webhook-delivered events - [HMAC and AES Authentication](https://developer.ordergroove.com/data/hmac-auth.md): Details for HMAC authentication and AES encryption used across Ordergroove integrations - [Webhooks Overview](https://developer.ordergroove.com/data/webhooks-overview.md): Real-time HTTP notifications for subscription and order events in your Ordergroove program - [Installing Webhooks](https://developer.ordergroove.com/data/installing-webhooks.md): Configure webhooks from within the Ordergroove Admin to receive real-time event notifications - [Setting up a Webhook](https://developer.ordergroove.com/data/setting-up-webhooks.md): Create, configure, disable, re-enable, and delete webhook routes in the Ordergroove Admin - [Webhook Authentication](https://developer.ordergroove.com/data/webhook-authentication.md): Verify webhook request authenticity using signing keys and understand the key rotation process - [Webhooks Verification](https://developer.ordergroove.com/data/webhook-verification.md): Verify the authenticity of Ordergroove webhook requests using HMAC-SHA256 payload signing - [Webhooks Test Events](https://developer.ordergroove.com/data/webhook-test-events.md): Generate fake webhook payloads to test your webhook target without needing real customer data - [Event Payloads](https://developer.ordergroove.com/data/event-payloads.md): Understand the default webhook payload structure and how to extend it with additional entity data - [Subscriber Events](https://developer.ordergroove.com/data/subscriber-events.md): Subscriber event types, what triggers each one, and the fields its payload carries - [Subscription Events](https://developer.ordergroove.com/data/subscription-events.md): Subscription event types, what triggers each one, and the fields its payload carries - [Order Events](https://developer.ordergroove.com/data/order-events.md): Order event types, what triggers each one, and the fields its payload carries - [Item Events](https://developer.ordergroove.com/data/item-events.md): Order item event types, what triggers each one, and the fields its payload carries - [Webhook Troubleshooting and Monitoring](https://developer.ordergroove.com/data/webhook-troubleshooting.md): Search delivery logs and review route-level metrics to diagnose and monitor webhook performance - [Configure Webhooks via API](https://developer.ordergroove.com/data/configure-webhooks.md): Set up webhook targets and event filters programmatically using the Ordergroove Webhooks API - [Expiring or Termed Subscriptions Using Webhooks](https://developer.ordergroove.com/data/termed-subscriptions.md): Set up termed subscriptions that automatically expire after a set number of fulfillments - [Digital Subscriptions](https://developer.ordergroove.com/advanced/digital-subscriptions.md): Deliver ongoing access to non-physical goods like memberships, streaming content, and eLearning using Ordergroove's digital subscription platform - [Free Trials](https://developer.ordergroove.com/advanced/free-trials.md): Give customers a trial period before their first paid order, with automatic handling of next order dates and digital entitlements - [Migrating Digital Subscriptions](https://developer.ordergroove.com/advanced/migrating-digital.md): Move existing digital subscribers into Ordergroove while preserving their entitlements and access - [Rotating Subscriptions](https://developer.ordergroove.com/advanced/rotating-subscriptions.md): Subscribe customers to a curated, pre-planned series of products using ordinal or time-window selection rules - [Ordinal Based Rotating Products](https://developer.ordergroove.com/advanced/ordinal-rotating.md): Deliver a pre-planned sequence of products based on each customer's order position within the subscription - [Time Window Based Rotating Products](https://developer.ordergroove.com/advanced/time-window-rotating.md): Deliver products based on configurable time windows so customers automatically receive the right item at the right time - [Prepaid Subscriptions Overview](https://developer.ordergroove.com/advanced/prepaid.md): How prepaid subscription data is represented on a subscription, and what each field means - [Managing Prepaid Renewal Behaviors](https://developer.ordergroove.com/advanced/prepaid-renewal.md): Control what happens when all prepaid orders are placed — auto-renew, cancel, or downgrade - [Curation Subscriptions - Rotating Box or Club](https://developer.ordergroove.com/advanced/curation.md): Send customers a different set of products with each shipment using Ordergroove's curation subscription support - [Guided Selling](https://developer.ordergroove.com/advanced/guided-selling.md): Integrate Ordergroove into quiz-based product discovery flows to capture subscription enrollment alongside personalized recommendations - [Bundle Subscriptions](https://developer.ordergroove.com/advanced/bundle-subscriptions.md): Manage a single subscription with multiple items, giving customers flexibility to customize their bundle - [Configuring Bundles](https://developer.ordergroove.com/advanced/bundle-config.md): Step-by-step guide to setting up Bundle Subscriptions in your store - [Box Subscription Creation on Shopify](https://developer.ordergroove.com/advanced/shopify-box.md): Configure Ordergroove to create bundled subscriptions for multiple line items in a Shopify checkout - [Bundle API Components](https://developer.ordergroove.com/advanced/bundle-api.md): API endpoints for viewing and managing multi-product bundle subscriptions, components, and items - [Build Your Own Box Subscriptions (Legacy)](https://developer.ordergroove.com/advanced/byob-legacy.md): Set up legacy bundle subscriptions that let customers configure multiple items under a single subscription at a set price - [Shopify - Build Your Own Box Subscriptions (Legacy)](https://developer.ordergroove.com/advanced/byob-shopify.md): Set up legacy bundle subscriptions on Shopify, where components are passed as cart attributes during checkout - [Migrate data to Ordergroove](https://developer.ordergroove.com/migrating/migrate-data.md): File format and field reference for migrating customers, subscriptions, payments, and addresses into Ordergroove - [Self-serve migration guide](https://developer.ordergroove.com/migrating/self-serve.md): Step-by-step guide to migrating your subscription program into Ordergroove using the legacy migration tool - [Self-serve migration guide for Recharge](https://developer.ordergroove.com/migrating/self-serve-recharge.md): Step-by-step guide to migrating your Recharge subscription program into Ordergroove - [Staged Migrations](https://developer.ordergroove.com/migrating/staged.md): Migrate from another subscription platform to Ordergroove in incremental phases while both platforms remain active - [Start Here](https://developer.ordergroove.com/start-here.md): Get up and running with the Ordergroove API - [Authentication](https://developer.ordergroove.com/api-reference/authentication.md): Access control for Ordergroove's REST APIs - [API Rate Limits](https://developer.ordergroove.com/api-reference/rate-limits.md): IP-based rate limiting on Ordergroove REST endpoints - [Resource Overview](https://developer.ordergroove.com/api-reference/resource-overview.md): Core resources and extensions in Ordergroove's data model - [Cursor Pagination](https://developer.ordergroove.com/api-reference/cursor-pagination.md): How to traverse large data sets - [Order Status Codes](https://developer.ordergroove.com/api-reference/order-status-codes.md): The numeric codes returned in an order's status field, and what each one means - [Credit Card Types](https://developer.ordergroove.com/api-reference/credit-card-types.md): The cc_type codes used in payment-related requests - [Webhooks API Overview](https://developer.ordergroove.com/reference/webhooks-overview.md): Receive real-time event notifications from Ordergroove when subscription and order activity occurs - [GraphQL Introduction](https://developer.ordergroove.com/graphql/introduction.md): Fetch subscription and order data with a single GraphQL request - [REST vs GraphQL](https://developer.ordergroove.com/graphql/rest-vs-graphql.md): Key differences for developers moving between Ordergroove's two APIs - [GraphQL Documentation](https://developer.ordergroove.com/graphql/graph-ql-guide/graph-ql-documentation.md) - [order](https://developer.ordergroove.com/graphql/graphql-definitions/queries/order.md): Fetch a single order by its globally unique ID - [orders](https://developer.ordergroove.com/graphql/graphql-definitions/queries/orders.md): List orders with cursor pagination and filters - [subscription](https://developer.ordergroove.com/graphql/graphql-definitions/queries/subscription.md): Fetch a single subscription by its public ID - [subscriptions](https://developer.ordergroove.com/graphql/graphql-definitions/queries/subscriptions.md): List subscriptions with cursor pagination and filters - [AddressType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/address-type.md) - [ApplicationType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/application-type.md) - [AppliedIncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/applied-incentive-type.md) - [BaseIncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/base-incentive-type.md) - [CancelReasonType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/cancel-reason-type.md) - [ComponentType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/component-type.md) - [CustomerType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/customer-type.md) - [DiscountIncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/discount-incentive-type.md) - [FreeTrialSubscriptionContextType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/free-trial-context-type.md) - [GiftContextType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/gift-context-type.md) - [GiftIncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/gift-incentive-type.md) - [GranteeType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/grantee-type.md) - [IncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/incentive-type.md) - [ItemsPage](https://developer.ordergroove.com/graphql/graphql-definitions/objects/items-page.md) - [ItemType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/item-type.md) - [OneTimeIncentiveType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/one-time-incentive-type.md) - [OrderConnection](https://developer.ordergroove.com/graphql/graphql-definitions/objects/order-connection.md) - [OrderEdge](https://developer.ordergroove.com/graphql/graphql-definitions/objects/order-edge.md) - [OrderType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/order-type.md) - [PaymentType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/payment-type.md) - [PrepaidSubscriptionContextType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/prepaid-context-type.md) - [ProductGroupType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/product-group-type.md) - [ProductType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/product-type.md) - [QueuedActionType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/queued-action-type.md) - [SourceType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/source-type.md) - [SubscriptionConnection](https://developer.ordergroove.com/graphql/graphql-definitions/objects/subscription-connection.md) - [SubscriptionEdge](https://developer.ordergroove.com/graphql/graphql-definitions/objects/subscription-edge.md) - [SubscriptionType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/subscription-type.md) - [SwappableProductType](https://developer.ordergroove.com/graphql/graphql-definitions/objects/swappable-product-type.md) ## API Docs - REST RPC API > Offer Profiles [List offer profiles](https://developer.ordergroove.com/reference/rest-rpc-api/offer-profiles/offer-profile-list.md) - REST RPC API > Offer Profiles [List Standardized Flex Incentives](https://developer.ordergroove.com/reference/rest-rpc-api/offer-profiles/list-standardized-flex-incentives.md) - REST RPC API > Orders [List](https://developer.ordergroove.com/reference/rest-rpc-api/orders/list.md) - REST RPC API > Orders [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/orders/retrieve.md) - REST RPC API > Orders [Cancel](https://developer.ordergroove.com/reference/rest-rpc-api/orders/cancel.md) - REST RPC API > Orders [Send Now](https://developer.ordergroove.com/reference/rest-rpc-api/orders/send-now.md) - REST RPC API > Orders [Change Shipping Address](https://developer.ordergroove.com/reference/rest-rpc-api/orders/change-shipping-address.md) - REST RPC API > Orders [Change Payment](https://developer.ordergroove.com/reference/rest-rpc-api/orders/change-payment.md) - REST RPC API > Orders [Change Place Date](https://developer.ordergroove.com/reference/rest-rpc-api/orders/change-place-date.md) - REST RPC API > Orders [Update](https://developer.ordergroove.com/reference/rest-rpc-api/orders/update.md) - REST RPC API > Orders [Finalize processing Order](https://developer.ordergroove.com/reference/rest-rpc-api/orders/finalize-processing-order.md) - REST RPC API > Orders [Template Title](https://developer.ordergroove.com/reference/rest-rpc-api/orders/list-copy.md) - REST RPC API > Orders [Skip Subscription](https://developer.ordergroove.com/reference/rest-rpc-api/orders/skip-subscription.md) - REST RPC API > Orders [Rescue](https://developer.ordergroove.com/reference/rest-rpc-api/orders/order-rescue.md) - REST RPC API > Orders [Retry](https://developer.ordergroove.com/reference/rest-rpc-api/orders/retry-order-1.md) - REST RPC API > Orders [Rescuable Check](https://developer.ordergroove.com/reference/rest-rpc-api/orders/rescue-copy.md) - REST RPC API > Retention Incentives [Create retention incentives for a customer](https://developer.ordergroove.com/reference/rest-rpc-api/retention-incentives/create.md) - REST RPC API > Retention Incentives [Create a retention incentive eligibility rule](https://developer.ordergroove.com/reference/rest-rpc-api/retention-incentives/eligibility-rules-create.md) - REST RPC API > Subscriptions [List](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/list.md) - REST RPC API > Subscriptions [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/retrieve.md) - REST RPC API > Subscriptions [Cancel](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/cancel.md) - REST RPC API > Subscriptions [Change Quantity](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-quantity.md) - REST RPC API > Subscriptions [Change Shipping Address](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-shipping-address.md) - REST RPC API > Subscriptions [Change Payment](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-payment.md) - REST RPC API > Subscriptions [Change Email Reminder](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-email-reminder.md) - REST RPC API > Subscriptions [Change Frequency](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-frequency.md) - REST RPC API > Subscriptions [Reactivate](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/reactivate.md) - REST RPC API > Subscriptions [Update](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/update.md) - REST RPC API > Subscriptions [Create in Order](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/create-in-order.md) - REST RPC API > Subscriptions [Create From Item](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/create-from-item.md) - REST RPC API > Subscriptions [Change Product](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-product.md) - REST RPC API > Subscriptions [Retrieve Rotating Ordinal Subscription Context](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/retrieve-ordinal-subscription-context.md) - REST RPC API > Subscriptions [Set Subscription Ordinal for Rotating Product](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/set-subscription-ordinal-for-rotation-product.md) - REST RPC API > Subscriptions [Change Next Order Date](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-next-order-date.md) - REST RPC API > Subscriptions [Update Prepaid Subscription](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/update-prepaid-subscription-context.md) - REST RPC API > Subscriptions [Change Prepaid Renewal Behavior](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/change-prepaid-subscription-renewal-behavior.md) - REST RPC API > Subscriptions [Upgrade Subscription To Prepaid](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/upgrade-to-prepaid-subscription.md) - REST RPC API > Components [Retrieve Component](https://developer.ordergroove.com/reference/rest-rpc-api/components/retrieve-component.md) - REST RPC API > Components [Update Components](https://developer.ordergroove.com/reference/rest-rpc-api/components/update-components.md) - REST RPC API > Items [List](https://developer.ordergroove.com/reference/rest-rpc-api/items/list.md) - REST RPC API > Items [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/items/retrieve.md) - REST RPC API > Items [Change Quantity](https://developer.ordergroove.com/reference/rest-rpc-api/items/change-quantity.md) - REST RPC API > Items [Change Price](https://developer.ordergroove.com/reference/rest-rpc-api/items/change-price.md) - REST RPC API > Items [Create](https://developer.ordergroove.com/reference/rest-rpc-api/items/create.md) - REST RPC API > Items [Create in Order](https://developer.ordergroove.com/reference/rest-rpc-api/items/create-in-order.md) - REST RPC API > Items [Delete](https://developer.ordergroove.com/reference/rest-rpc-api/items/delete.md) - REST RPC API > Items [Update](https://developer.ordergroove.com/reference/rest-rpc-api/items/update.md) - REST RPC API > Items [Product Change](https://developer.ordergroove.com/reference/rest-rpc-api/items/product-change.md) - REST RPC API > Customers [List](https://developer.ordergroove.com/reference/rest-rpc-api/customers/list.md) - REST RPC API > Customers [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/customers/retrieve.md) - REST RPC API > Customers [Create](https://developer.ordergroove.com/reference/rest-rpc-api/customers/create.md) - REST RPC API > Customers [Update](https://developer.ordergroove.com/reference/rest-rpc-api/customers/update.md) - REST RPC API > Customers [Set Contact Details](https://developer.ordergroove.com/reference/rest-rpc-api/customers/set-contact-details.md) - REST RPC API > Customers [Rename grantee](https://developer.ordergroove.com/reference/rest-rpc-api/customers/rename-grantee.md) - REST RPC API > Merchant [List Cancellation Reasons](https://developer.ordergroove.com/reference/rest-rpc-api/merchant/list-cancellation-reasons.md) - REST RPC API > Addresses [List](https://developer.ordergroove.com/reference/rest-rpc-api/addresses/list.md) - REST RPC API > Addresses [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/addresses/retrieve.md) - REST RPC API > Addresses [Create](https://developer.ordergroove.com/reference/rest-rpc-api/addresses/create.md) - REST RPC API > Addresses [Update](https://developer.ordergroove.com/reference/rest-rpc-api/addresses/update.md) - REST RPC API > Addresses [Use address for all](https://developer.ordergroove.com/reference/rest-rpc-api/addresses/use-address-for-all.md) - REST RPC API > Payments [List](https://developer.ordergroove.com/reference/rest-rpc-api/payments/list.md) - REST RPC API > Payments [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/payments/retrieve.md) - REST RPC API > Payments [Create](https://developer.ordergroove.com/reference/rest-rpc-api/payments/create.md) - REST RPC API > Payments [Update](https://developer.ordergroove.com/reference/rest-rpc-api/payments/update.md) - REST RPC API > Payments [Use payment for all](https://developer.ordergroove.com/reference/rest-rpc-api/payments/use-payment-for-all.md) - REST RPC API > Products [List](https://developer.ordergroove.com/reference/rest-rpc-api/products/list.md) - REST RPC API > Products [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/products/retrieve.md) - REST RPC API > Products [Group Check](https://developer.ordergroove.com/reference/rest-rpc-api/products/group-check.md) - REST RPC API > Products [Relationships](https://developer.ordergroove.com/reference/rest-rpc-api/products/product-relationships.md) - REST RPC API > Products [Bulk Create](https://developer.ordergroove.com/reference/rest-rpc-api/products/bulk-create.md) - REST RPC API > Products [Bulk Update](https://developer.ordergroove.com/reference/rest-rpc-api/products/bulk-update.md) - REST RPC API > Products [Manage Time-Window Rotating Product](https://developer.ordergroove.com/reference/rest-rpc-api/products/manage-time-window-rotating-product.md) - REST RPC API > Products [Manage Ordinal Rotating Product](https://developer.ordergroove.com/reference/rest-rpc-api/products/manage-ordinal-rotating-product.md) - REST RPC API > Products [Retrieve Rotating Delivery Product](https://developer.ordergroove.com/reference/rest-rpc-api/products/rotating-products.md) - REST RPC API > Products [Manage Digital Plan Product](https://developer.ordergroove.com/reference/rest-rpc-api/products/manage-digital-plan-product.md) - REST RPC API > Products [Free Trial Create](https://developer.ordergroove.com/reference/rest-rpc-api/products/free-trials-create.md) - REST RPC API > Products [Free Trial Update](https://developer.ordergroove.com/reference/rest-rpc-api/products/free-trials-update.md) - REST RPC API > Products [Free Trial Delete](https://developer.ordergroove.com/reference/rest-rpc-api/products/free-trials-delete.md) - REST RPC API > Products [List price codes](https://developer.ordergroove.com/reference/rest-rpc-api/products/product-price-codes-list.md) - REST RPC API > Products [Create or update price codes](https://developer.ordergroove.com/reference/rest-rpc-api/products/product-price-codes-upsert.md) - REST RPC API > Products [Retrieve a price code](https://developer.ordergroove.com/reference/rest-rpc-api/products/product-price-codes-retrieve.md) - REST RPC API > Products [Delete a price code](https://developer.ordergroove.com/reference/rest-rpc-api/products/product-price-codes-delete.md) - REST RPC API > Products [Update](https://developer.ordergroove.com/reference/rest-rpc-api/products/update.md) - REST RPC API > Product Groups [List](https://developer.ordergroove.com/reference/rest-rpc-api/product-groups/list.md) - REST RPC API > Product Groups [Create](https://developer.ordergroove.com/reference/rest-rpc-api/product-groups/create.md) - REST RPC API > Product Groups [Update](https://developer.ordergroove.com/reference/rest-rpc-api/product-groups/update.md) - REST RPC API > Resources [List](https://developer.ordergroove.com/reference/rest-rpc-api/resources/resource-list.md) - REST RPC API > Resources [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/resources/resource-retrieve.md) - REST RPC API > Resources [Create](https://developer.ordergroove.com/reference/rest-rpc-api/resources/resource-create.md) - REST RPC API > Resources [Update](https://developer.ordergroove.com/reference/rest-rpc-api/resources/resource-update.md) - REST RPC API > One Time Incentives [List](https://developer.ordergroove.com/reference/rest-rpc-api/one-time-incentives/otd-list.md) - REST RPC API > One Time Incentives [Retrieve](https://developer.ordergroove.com/reference/rest-rpc-api/one-time-incentives/otd-retrieve.md) - REST RPC API > One Time Incentives [Update](https://developer.ordergroove.com/reference/rest-rpc-api/one-time-incentives/otd-update.md) - REST RPC API > One Time Incentives [Delete](https://developer.ordergroove.com/reference/rest-rpc-api/one-time-incentives/otd-delete.md) - REST RPC API > One Time Incentives [Create](https://developer.ordergroove.com/reference/rest-rpc-api/one-time-incentives/otd-create.md) - REST RPC API > One Click [1-Click Delay](https://developer.ordergroove.com/reference/rest-rpc-api/one-click/1-click-delay.md) - REST RPC API > One Click [1-Click Reactivate](https://developer.ordergroove.com/reference/rest-rpc-api/one-click/1-click-reactivate.md) - REST RPC API > One Click [Get New Endpoint](https://developer.ordergroove.com/reference/rest-rpc-api/one-click/get-new-endpoint.md) - Entitlements Service API > Entitlements [List](https://developer.ordergroove.com/reference/entitlements-service-api/entitlements/list.md) - Entitlements Service API > Entitlements [Modify entitlement expiration](https://developer.ordergroove.com/reference/entitlements-service-api/entitlements/post-entitlements-modify-expiration.md) - Entitlements Service API > Entitlements [Void entitlements](https://developer.ordergroove.com/reference/entitlements-service-api/entitlements/post-entitlements-void.md) - Cart Management API > Carts [Retrieve](https://developer.ordergroove.com/reference/cart-management-api/carts/cart-retrieve.md) - Payment API > Payment Requests [Purchase POST API](https://developer.ordergroove.com/reference/payment-api/payment-requests/purchase-post-api.md) - Payment API > Payment Requests [Purchase POST Status](https://developer.ordergroove.com/reference/payment-api/payment-requests/purchase-post-status.md) - Webhooks API > Webhook Targets [List](https://developer.ordergroove.com/reference/webhooks-api/webhook-targets/list.md) - Webhooks API > Webhook Targets [Retrieve](https://developer.ordergroove.com/reference/webhooks-api/webhook-targets/retrieve.md) - Webhooks API > Webhook Targets [Update](https://developer.ordergroove.com/reference/webhooks-api/webhook-targets/create-5.md) - Webhooks API > Webhook Targets [Create](https://developer.ordergroove.com/reference/webhooks-api/webhook-targets/create.md) - Webhooks API > Webhook Metrics [Retrieve Target Metrics](https://developer.ordergroove.com/reference/webhooks-api/webhook-metrics/retrieve-metrics.md) - Webhooks API > Webhook Filters [List](https://developer.ordergroove.com/reference/webhooks-api/webhook-filters/list.md) - Webhooks API > Webhook Filters [Create](https://developer.ordergroove.com/reference/webhooks-api/webhook-filters/create.md) - Webhooks API > Webhook Filters [Retrieve](https://developer.ordergroove.com/reference/webhooks-api/webhook-filters/webhook-filter-retrieve.md) - Webhooks API > Webhook Filters [Delete](https://developer.ordergroove.com/reference/webhooks-api/webhook-filters/delete.md) - Webhooks API > Webhook Filters [Update](https://developer.ordergroove.com/reference/webhooks-api/webhook-filters/update.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developer.ordergroove.com/openapi.json) - [OpenAPI YAML](https://developer.ordergroove.com/openapi.yaml)