subscriptions
List of subscriptions
Arguments
offerDefinitionId (ID)
Filter by a configured offer, including archived offers.
offerEvent (PromotionalOfferEvent)
Filter by a historical event on that offer. Requires offerDefinitionId; defaults to ISSUED.
offerEventSince (ISO8601DateTime)
Inclusive start for the offer event timestamp. Requires offerDefinitionId and offerEvent.
offerEventUntil (ISO8601DateTime)
Exclusive end for the offer event timestamp. Requires offerDefinitionId and offerEvent.
signupCompletedSince (ISO8601DateTime)
Filter subscriptions to those who completed their signup since a certain time.
signupCompletedUntil (ISO8601DateTime)
Filter subscriptions to those who completed their signup until a certain time.
updatedSince (ISO8601DateTime)
Filter subscriptions to those who were updated since the given datetime.
updatedUntil (ISO8601DateTime)
Filter subscriptions to those that where updated until the given datetime.
ids ([ID!])
Filter subscriptions to those of specific IDs.
customerReferences ([String!])
Filter subscriptions to those of specific customer references.
countries ([String!])
Filter subscriptions to those with specific country codes (ISO 3166-1 alpha-2).
planIds ([ID!])
Filter subscriptions to those subscribed to specific plan IDs.
nextBillingDate (ISO8601Date)
Filter subscriptions to those with a specific next billing date.
statuses ([SubscriptionStatus!])
Filter subscriptions to those of specific statuses. Lists all subscriptions except DRAFT if none given.
email (String)
Filter subscriptions to those with a specific email address (case-insensitive).
query (String)
Search subscriptions by customer name, email, token, ID, customer reference, or company name.
after (String)
Returns the elements in the list that come after the specified cursor.
before (String)
Returns the elements in the list that come before the specified cursor.
first (Int)
Returns the first n elements from the list.
last (Int)
Returns the last n elements from the list.
Return fields
edges ([SubscriptionEdge])
A list of edges.
nodes ([Subscription])
A list of nodes.
pageInfo (PageInfo!)
Information to aid in pagination.
totalCount (Int)
The total number of items available.
Last updated
Was this helpful?