PrepaidSubscriptionContext

PrepaidSubscriptionContextType fields

lastRenewalRevenue Decimal! Non-null
prepaidOrdersPerBilling Int! Non-null
prepaidOrdersRemaining Int! Non-null
prepaidOriginMerchantOrderId String
renewalBehavior String! Non-null

Show query

Check prepaid subscription progress for each line item

GraphQL cURL Node.js Python

query {
  order(publicId: "abc123") {
    publicId
    status
    subTotal
    total
    place
    items {
      nodes {
        publicId
        quantity
        price
        totalPrice
        product {
          name
          externalProductId
          sku
        }
        subscription {
          publicId
          every
          everyPeriod
          prepaidSubscriptionContext {
            prepaidOrdersRemaining
            prepaidOrdersPerBilling
            renewalBehavior
            lastRenewalRevenue
            prepaidOriginMerchantOrderId
          }
        }
      }
    }
  }
}

curl -X POST https://restapi.ordergroove.com/graphql/2026-01/ \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"query": "query { order(publicId: \"abc123\") { publicId status subTotal total place items { nodes { publicId quantity price totalPrice product { name externalProductId sku } subscription { publicId every everyPeriod prepaidSubscriptionContext { prepaidOrdersRemaining prepaidOrdersPerBilling renewalBehavior lastRenewalRevenue prepaidOriginMerchantOrderId } } } } } }"}'

const query = `
query {
  order(publicId: "abc123") {
    publicId
    status
    subTotal
    total
    place
    items {
      nodes {
        publicId
        quantity
        price
        totalPrice
        product {
          name
          externalProductId
          sku
        }
        subscription {
          publicId
          every
          everyPeriod
          prepaidSubscriptionContext {
            prepaidOrdersRemaining
            prepaidOrdersPerBilling
            renewalBehavior
            lastRenewalRevenue
            prepaidOriginMerchantOrderId
          }
        }
      }
    }
  }
}
`;

const response = await fetch(
  "https://restapi.ordergroove.com/graphql/2026-01/",
  {
    method: "POST",
    headers: {
      "X-API-KEY: <your-api-key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ query }),
  }
);

const data = await response.json();

import requests

query = """
query {
  order(publicId: "abc123") {
    publicId
    status
    subTotal
    total
    place
    items {
      nodes {
        publicId
        quantity
        price
        totalPrice
        product {
          name
          externalProductId
          sku
        }
        subscription {
          publicId
          every
          everyPeriod
          prepaidSubscriptionContext {
            prepaidOrdersRemaining
            prepaidOrdersPerBilling
            renewalBehavior
            lastRenewalRevenue
            prepaidOriginMerchantOrderId
          }
        }
      }
    }
  }
}
"""

response = requests.post(
    "https://restapi.ordergroove.com/graphql/2026-01/",
    headers={
        "X-API-KEY: <your-api-key>",
        "Content-Type": "application/json",
    },
    json={"query": query},
)

data = response.json()

List subscriptions with prepaid statussubscriptions

Show query

Subscriptions with prepaid context for tracking remaining orders

GraphQL cURL Node.js Python

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

curl -X POST https://restapi.ordergroove.com/graphql/2026-01/ \
  -H "X-API-KEY: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"query": "query { subscriptions(customer: \"cust123\", first: 25) { edges { node { publicId every everyPeriod quantity price live product { name externalProductId sku } prepaidSubscriptionContext { prepaidOrdersRemaining prepaidOrdersPerBilling renewalBehavior lastRenewalRevenue prepaidOriginMerchantOrderId } } } } }"}'

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

const response = await fetch(
  "https://restapi.ordergroove.com/graphql/2026-01/",
  {
    method: "POST",
    headers: {
      "X-API-KEY: <your-api-key>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ query }),
  }
);

const data = await response.json();

import requests

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

response = requests.post(
    "https://restapi.ordergroove.com/graphql/2026-01/",
    headers={
        "X-API-KEY: <your-api-key>",
        "Content-Type": "application/json",
    },
    json={"query": query},
)

data = response.json()