Ordergroove Developer Documentation

The subscriptions query returns SubscriptionConnection.

Arguments

Argument	Type	Required	Description
`after`	`String`	No	Cursor to paginate forward from.
`before`	`String`	No	Cursor to paginate backward from.
`customer`	`String`	No	Filter by customer ID.
`first`	`Int`	No	Return the first N results.
`last`	`Int`	No	Return the last N results.
`live`	`Boolean`	No	Filter by subscription status. Requires a customer scope (customer auth or customer argument).
`productGroup`	`String`	No	Filter subscriptions whose product belongs to a ProductGroup with this name.

Return type: `SubscriptionConnection`

Field	Type	Required
`edges`	`[SubscriptionEdge!]!`	Yes
`pageInfo`	`PageInfo!`	Yes

Examples

List customer subscriptions

Retrieve all subscriptions for a customer with product info

query {
  subscriptions(customer: "cust123", first: 25) {
    edges {
      node {
        publicId
        every
        everyPeriod
        quantity
        price
        live
        startDate
        product {
          name
          externalProductId
          sku
          imageUrl
        }
      }
    }
  }
}

List subscriptions with pagination

Page through a customer’s subscriptions using cursor-based pagination

query {
  subscriptions(customer: "cust123", first: 10, after: "cursor123") {
    edges {
      cursor
      node {
        publicId
        every
        everyPeriod
        quantity
        price
        live
        startDate
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
  }
}

List subscriptions with delivery details

Subscriptions with shipping address and payment info

query {
  subscriptions(customer: "cust123", first: 25) {
    edges {
      node {
        publicId
        every
        everyPeriod
        quantity
        price
        live
        cancelled
        shippingAddress {
          firstName
          lastName
          address
          city
          stateProvinceCode
          zipPostalCode
        }
        payment {
          ccType
          ccNumberEnding
          paymentMethod
        }
        product {
          name
          externalProductId
          sku
        }
      }
    }
  }
}

List subscriptions with prepaid status

Subscriptions with prepaid context for tracking remaining orders

query {
  subscriptions(customer: "cust123", first: 25) {
    edges {
      node {
        publicId
        every
        everyPeriod
        quantity
        price
        live
        product {
          name
          externalProductId
          sku
        }
        prepaidSubscriptionContext {
          prepaidOrdersRemaining
          prepaidOrdersPerBilling
          renewalBehavior
          lastRenewalRevenue
          prepaidOriginMerchantOrderId
        }
      }
    }
  }
}