> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.ordergroove.com/reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.ordergroove.com/_mcp/server.

# API Reference

> APIs and guides for building subscription commerce with Ordergroove.

## Docs

- [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
- [Retry Instructions](https://developer.ordergroove.com/api-reference/retry-instructions.md): Tell Ordergroove whether to retry or reject an order that failed placement
- [Order Billing Attempts](https://developer.ordergroove.com/api-reference/order-billing-attempts.md): The record Ordergroove keeps each time it places an order, and how to read it
- [Webhooks API Overview](https://developer.ordergroove.com/reference/webhooks-overview.md): Receive real-time event notifications from Ordergroove when subscription and order activity occurs

## 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 > 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 [Skip Subscription](https://developer.ordergroove.com/reference/rest-rpc-api/orders/skip-subscription.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 [Rescue](https://developer.ordergroove.com/reference/rest-rpc-api/orders/order-rescue.md)
- REST RPC API > Orders [Rescuable Check](https://developer.ordergroove.com/reference/rest-rpc-api/orders/rescuable-check.md)
- REST RPC API > Orders [Retry](https://developer.ordergroove.com/reference/rest-rpc-api/orders/retry.md)
- REST RPC API > Orders [Reject](https://developer.ordergroove.com/reference/rest-rpc-api/orders/reject-order.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 [Void subscription entitlements](https://developer.ordergroove.com/reference/rest-rpc-api/subscriptions/void-entitlements.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 [1-Click Skip](https://developer.ordergroove.com/reference/rest-rpc-api/one-click/1-click-skip.md)
- Entitlements Service API > Entitlements [List entitlements](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)
- Subscription Creation API > Purchase POST Requests [Purchase POST API](https://developer.ordergroove.com/reference/payment-api/payment-requests/purchase-post-api.md)
- Subscription Creation API > Purchase POST Requests [Purchase POST Status](https://developer.ordergroove.com/reference/payment-api/payment-requests/purchase-post-status.md)
- Payment Attempt Data API > Placement Responses [Retrieve placement responses](https://developer.ordergroove.com/reference/payment-attempt-data-api/placement-responses/retrieve-placement-responses.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/update.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)