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

query {
  subscription(publicId: "sub123") {
    publicId
    every
    everyPeriod
    quantity
    price
    live
    startDate
    created
    product {
      name
      externalProductId
      sku
      imageUrl
    }
  }
}

Get subscription for account management

Full subscription details for editing customer, shipping, and payment

query {
  subscription(publicId: "sub123") {
    publicId
    every
    everyPeriod
    quantity
    price
    live
    cancelled
    cancelReason
    startDate
    currencyCode
    customer {
      merchantUserId
      firstName
      lastName
      email
      phoneNumber
    }
    shippingAddress {
      publicId
      firstName
      lastName
      address
      address2
      city
      stateProvinceCode
      zipPostalCode
      countryCode
      phone
    }
    payment {
      publicId
      ccType
      ccNumberEnding
      ccExpDate
      ccHolder
      paymentMethod
    }
    product {
      name
      externalProductId
      sku
      price
      imageUrl
    }
  }
}

Get bundle subscription components

Retrieve a subscription’s bundle components with product details

query {
  subscription(publicId: "sub123") {
    publicId
    every
    everyPeriod
    quantity
    price
    live
    product {
      name
      externalProductId
    }
    components {
      publicId
      quantity
      product {
        name
        externalProductId
        sku
        price
      }
    }
  }
}