Ordergroove Developer Documentation

The subscription query returns SubscriptionType.

Arguments

Argument	Type	Required	Description
`publicId`	`String!`	Yes	The globally unique ID of the subscription.

Return type: `SubscriptionType`

Field	Type	Required
`cancelReason`	`String`	No
`cancelReasonCode`	`CancelReasonType`	No
`cancelled`	`DateTime`	No
`components`	`[ComponentType!]`	No
`created`	`DateTime`	No
`currencyCode`	`String`	No
`customer`	`CustomerType`	No
`every`	`Int`	No
`everyPeriod`	`Int`	No
`externalId`	`String`	No
`extraData`	`String`	No
`freeTrialSubscriptionContext`	`FreeTrialSubscriptionContextType`	No
`frequencyDays`	`Int`	No
`grantees`	`[GranteeType!]!`	Yes
`id`	`ID!`	Yes
`live`	`Boolean!`	Yes
`merchantOrderId`	`String`	No
`merchantPublicId`	`String!`	Yes
`offerPublicId`	`String`	No
`payment`	`PaymentType`	No
`prepaidSubscriptionContext`	`PrepaidSubscriptionContextType`	No
`price`	`Decimal`	No
`product`	`ProductType`	No
`publicId`	`String`	No
`quantity`	`Int!`	Yes
`queuedActions`	`[QueuedActionType!]`	No
`reminderDays`	`Int`	No
`sessionId`	`String!`	Yes
`shippingAddress`	`AddressType`	No
`startDate`	`Date!`	Yes
`subscriptionType`	`String`	No
`updated`	`DateTime`	No

Examples

Get subscription overview

Basic subscription info with product details

1 query {
2   subscription(publicId: "sub123") {
3     publicId
4     every
5     everyPeriod
6     quantity
7     price
8     live
9     startDate
10     created
11     product {
12       name
13       externalProductId
14       sku
15       imageUrl
16     }
17   }
18 }

Get subscription for account management

Full subscription details for editing customer, shipping, and payment

1 query {
2   subscription(publicId: "sub123") {
3     publicId
4     every
5     everyPeriod
6     quantity
7     price
8     live
9     cancelled
10     cancelReason
11     startDate
12     currencyCode
13     customer {
14       merchantUserId
15       firstName
16       lastName
17       email
18       phoneNumber
19     }
20     shippingAddress {
21       publicId
22       firstName
23       lastName
24       address
25       address2
26       city
27       stateProvinceCode
28       zipPostalCode
29       countryCode
30       phone
31     }
32     payment {
33       publicId
34       ccType
35       ccNumberEnding
36       ccExpDate
37       ccHolder
38       paymentMethod
39     }
40     product {
41       name
42       externalProductId
43       sku
44       price
45       imageUrl
46     }
47   }
48 }

Get bundle subscription components

Retrieve a subscription’s bundle components with product details

1 query {
2   subscription(publicId: "sub123") {
3     publicId
4     every
5     everyPeriod
6     quantity
7     price
8     live
9     product {
10       name
11       externalProductId
12     }
13     components {
14       publicId
15       quantity
16       product {
17         name
18         externalProductId
19         sku
20         price
21       }
22     }
23   }
24 }