| Argument | Type | Required | Description |
|---|
customer | String | No | Filter by customer ID. |
live | Boolean | No | Filter by subscription status. Requires a customer scope (customer auth or customer argument). |
first | Int | No | Return the first N results. |
after | String | No | Cursor to paginate forward from. |
last | Int | No | Return the last N results. |
before | String | No | Cursor to paginate backward from. |
SubscriptionConnection!
| Field | Type | Description |
|---|
edges | [SubscriptionEdge!]! | |
pageInfo | PageInfo! | |
| Field | Type | Description |
|---|
cursor | String! | |
node | SubscriptionType! | |
| Field | Type | Description |
|---|
id | ID! | The Globally Unique ID of this object |
publicId | String | |
quantity | Int! | |
price | Decimal | |
frequencyDays | Int | |
every | Int | |
everyPeriod | Int | |
startDate | Date! | |
cancelled | DateTime | |
cancelReason | String | |
subscriptionType | String | |
live | Boolean! | |
externalId | String | |
currencyCode | String | |
sessionId | String! | |
merchantOrderId | String | |
created | DateTime | |
updated | DateTime | |
extraData | String | |
reminderDays | Int | |
product | ProductType | |
customer | CustomerType | |
shippingAddress | AddressType | |
payment | PaymentType | |
merchantPublicId | String! | |
offerPublicId | String | |
cancelReasonCode | CancelReasonType | |
components | [ComponentType!] | |
prepaidSubscriptionContext | PrepaidSubscriptionContextType | |
freeTrialSubscriptionContext | FreeTrialSubscriptionContextType | |
grantees | [GranteeType!]! | |
queuedActions | [QueuedActionType!] | |
| Field | Type | Description |
|---|
name | String | |
price | Decimal! | |
externalProductId | String! | |
sku | String! | |
imageUrl | String | |
detailUrl | String | |
productType | String! | |
autoshipEnabled | Boolean! | |
autoshipByDefault | Boolean! | |
discontinued | Boolean! | |
live | Boolean! | |
every | Int | |
everyPeriod | Int | |
extraData | String | |
created | DateTime | |
lastUpdate | DateTime | |
groups | [ProductGroupType!]! | |
prepaidEligible | Boolean! | |
| Field | Type | Description |
|---|
name | String! | |
groupType | String! | |
| Field | Type | Description |
|---|
merchantUserId | String | |
firstName | String | |
lastName | String | |
email | String | |
phoneNumber | String | |
phoneType | Int | |
priceCode | String | |
live | Boolean! | |
created | DateTime! | |
lastUpdated | DateTime! | |
locale | Int | |
extraData | String | |
| Field | Type | Description |
|---|
publicId | String | |
firstName | String! | |
lastName | String! | |
address | String! | |
address2 | String | |
city | String! | |
stateProvinceCode | String! | |
zipPostalCode | String! | |
countryCode | String! | |
companyName | String | |
phone | String | |
fax | String | |
tokenId | String | |
priceCode | String | |
label | String | |
live | Boolean! | |
created | DateTime! | |
| Field | Type | Description |
|---|
publicId | String | |
ccType | Int | |
paymentMethod | Int | |
label | String | |
cycle | Int | |
cycleStatus | Int | |
live | Boolean! | |
created | DateTime! | |
lastUpdated | DateTime! | |
tokenId | String | |
billingAddress | AddressType | |
ccNumberEnding | String | |
ccExpDate | String | |
ccHolder | String | |
| Field | Type | Description |
|---|
code | Int! | |
reason | String! | |
| Field | Type | Description |
|---|
publicId | String! | |
quantity | Int | |
product | ProductType | |
| Field | Type | Description |
|---|
prepaidOrdersRemaining | Int! | |
prepaidOrdersPerBilling | Int! | |
renewalBehavior | String! | |
lastRenewalRevenue | Decimal! | |
prepaidOriginMerchantOrderId | String | |
| Field | Type | Description |
|---|
days | Int! | |
expiration | DateTime! | |
product | ProductType | |
conversionItem | String | |
isInFreeTrial | Boolean! | |
| Field | Type | Description |
|---|
externalId | String! | |
name | String! | |
| Field | Type | Description |
|---|
publicId | String! | |
skip | Boolean! | |
index | Int! | |
ordinal | Int! | |
date | DateTime | |
Information to aid in pagination.
| Field | Type | Description |
|---|
hasNextPage | Boolean! | When paginating forwards, are there more items? |
hasPreviousPage | Boolean! | When paginating backwards, are there more items? |
startCursor | String | When paginating backwards, the cursor to continue. |
endCursor | String | When paginating forwards, the cursor to continue. |