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

# SubscriptionType

## Fields

| Field                          | Type                                                                                               | Required |
| ------------------------------ | -------------------------------------------------------------------------------------------------- | -------- |
| `cancelReason`                 | `String`                                                                                           | No       |
| `cancelReasonCode`             | [`CancelReasonType`](/graphql/graphql-definitions/objects/cancel-reason-type)                      | No       |
| `cancelled`                    | `DateTime`                                                                                         | No       |
| `components`                   | [`[ComponentType!]`](/graphql/graphql-definitions/objects/component-type)                          | No       |
| `created`                      | `DateTime`                                                                                         | No       |
| `currencyCode`                 | `String`                                                                                           | No       |
| `customer`                     | [`CustomerType`](/graphql/graphql-definitions/objects/customer-type)                               | No       |
| `every`                        | `Int`                                                                                              | No       |
| `everyPeriod`                  | `Int`                                                                                              | No       |
| `externalId`                   | `String`                                                                                           | No       |
| `extraData`                    | `String`                                                                                           | No       |
| `freeTrialSubscriptionContext` | [`FreeTrialSubscriptionContextType`](/graphql/graphql-definitions/objects/free-trial-context-type) | No       |
| `frequencyDays`                | `Int`                                                                                              | No       |
| `grantees`                     | [`[GranteeType!]!`](/graphql/graphql-definitions/objects/grantee-type)                             | Yes      |
| `id`                           | `ID!`                                                                                              | Yes      |
| `live`                         | `Boolean!`                                                                                         | Yes      |
| `merchantOrderId`              | `String`                                                                                           | No       |
| `merchantPublicId`             | `String!`                                                                                          | Yes      |
| `offerPublicId`                | `String`                                                                                           | No       |
| `payment`                      | [`PaymentType`](/graphql/graphql-definitions/objects/payment-type)                                 | No       |
| `prepaidSubscriptionContext`   | [`PrepaidSubscriptionContextType`](/graphql/graphql-definitions/objects/prepaid-context-type)      | No       |
| `price`                        | `Decimal`                                                                                          | No       |
| `product`                      | [`ProductType`](/graphql/graphql-definitions/objects/product-type)                                 | No       |
| `publicId`                     | `String`                                                                                           | No       |
| `quantity`                     | `Int!`                                                                                             | Yes      |
| `queuedActions`                | [`[QueuedActionType!]`](/graphql/graphql-definitions/objects/queued-action-type)                   | No       |
| `reminderDays`                 | `Int`                                                                                              | No       |
| `sessionId`                    | `String!`                                                                                          | Yes      |
| `shippingAddress`              | [`AddressType`](/graphql/graphql-definitions/objects/address-type)                                 | No       |
| `startDate`                    | `Date!`                                                                                            | Yes      |
| `subscriptionType`             | `String`                                                                                           | No       |
| `updated`                      | `DateTime`                                                                                         | No       |

## Related queries

* [`order`](/graphql/graphql-definitions/queries/order) — Get subscription details by order
* [`order`](/graphql/graphql-definitions/queries/order) — Get prepaid subscription status by order
* [`orders`](/graphql/graphql-definitions/queries/orders) — Get subscription details by customer
* [`orders`](/graphql/graphql-definitions/queries/orders) — Get subscription details by subscription
* [`subscription`](/graphql/graphql-definitions/queries/subscription) — Get subscription overview
* [`subscription`](/graphql/graphql-definitions/queries/subscription) — Get subscription for account management
* [`subscription`](/graphql/graphql-definitions/queries/subscription) — Get bundle subscription components
* [`subscriptions`](/graphql/graphql-definitions/queries/subscriptions) — List customer subscriptions
* [`subscriptions`](/graphql/graphql-definitions/queries/subscriptions) — List subscriptions with pagination
* [`subscriptions`](/graphql/graphql-definitions/queries/subscriptions) — List subscriptions with delivery details
* [`subscriptions`](/graphql/graphql-definitions/queries/subscriptions) — List subscriptions with prepaid status