Address
AddressType fields
-
address String! Non-null
-
address2 String
-
city String! Non-null
-
companyName String
-
countryCode String! Non-null
-
created DateTime! Non-null
-
fax String
-
firstName String! Non-null
-
label String
-
lastName String! Non-null
-
live Boolean! Non-null
-
phone String
-
priceCode String
-
publicId String
-
stateProvinceCode String! Non-null
-
tokenId String
-
zipPostalCode String! Non-null
Related queries
-
Get subscription details by orderorder
Show query
Retrieve complete subscription details from order
query { order(publicId: "abc123") { publicId status subTotal shippingTotal discountTotal taxTotal total created place updated customer { merchantUserId firstName lastName email phoneNumber } shippingAddress { publicId firstName lastName address address2 city stateProvinceCode zipPostalCode countryCode phone } payment { publicId ccType ccNumberEnding ccExpDate ccHolder paymentMethod } items { nodes { publicId quantity price totalPrice product { name externalProductId sku every everyPeriod } subscription { publicId every everyPeriod } } } } }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 shippingTotal discountTotal taxTotal total created place updated customer { merchantUserId firstName lastName email phoneNumber } shippingAddress { publicId firstName lastName address address2 city stateProvinceCode zipPostalCode countryCode phone } payment { publicId ccType ccNumberEnding ccExpDate ccHolder paymentMethod } items { nodes { publicId quantity price totalPrice product { name externalProductId sku every everyPeriod } subscription { publicId every everyPeriod } } } } }"}'const query = ` query { order(publicId: "abc123") { publicId status subTotal shippingTotal discountTotal taxTotal total created place updated customer { merchantUserId firstName lastName email phoneNumber } shippingAddress { publicId firstName lastName address address2 city stateProvinceCode zipPostalCode countryCode phone } payment { publicId ccType ccNumberEnding ccExpDate ccHolder paymentMethod } items { nodes { publicId quantity price totalPrice product { name externalProductId sku every everyPeriod } subscription { publicId every everyPeriod } } } } } `; 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 shippingTotal discountTotal taxTotal total created place updated customer { merchantUserId firstName lastName email phoneNumber } shippingAddress { publicId firstName lastName address address2 city stateProvinceCode zipPostalCode countryCode phone } payment { publicId ccType ccNumberEnding ccExpDate ccHolder paymentMethod } items { nodes { publicId quantity price totalPrice product { name externalProductId sku every everyPeriod } subscription { publicId every everyPeriod } } } } } """ 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() -
Get subscription for account managementsubscription
Show query
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 } } }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 { 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 } } }"}'const query = ` 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 } } } `; 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 { 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 } } } """ 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 delivery detailssubscriptions
Show query
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 } } } } }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 cancelled shippingAddress { firstName lastName address city stateProvinceCode zipPostalCode } payment { ccType ccNumberEnding paymentMethod } product { name externalProductId sku } } } } }"}'const query = ` 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 } } } } } `; 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 cancelled shippingAddress { firstName lastName address city stateProvinceCode zipPostalCode } payment { ccType ccNumberEnding paymentMethod } product { name externalProductId sku } } } } } """ 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()