Skip to main content
Anchor to activeSubscription

activeSubscription

query

The active managed pricing subscription for a shop on a given app.

Anchor to Arguments

Arguments

Anchor to appIdappId
•ID!
required

The ID of the app to get the active subscription for. Example value: gid://shopify/App/1234.

Anchor to shopIdshopId
•ID!
required

The ID of the shop to get the active subscription for. Example value: gid://shopify/Shop/1234.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ActiveSubscriptionActiveSubscription
•ActiveSubscription

Represents an active pricing subscription between a shop and an app.

Anchor to appapp
•AppReference!
non-null

The app that provides this subscription.

Anchor to billingPeriodbillingPeriod
•AppPricingInterval!
non-null

The frequency at which the shop is billed for an app subscription.

Anchor to cancelAtEndOfCyclecancelAtEndOfCycle
•Boolean!
non-null

Returns true if the subscription will be cancelled at the end of the cycle.

Anchor to currentBillingCyclecurrentBillingCycle
•BillingCycle

The current billing cycle for the subscription. Returns null if the subscription is still in trial.

Anchor to itemsitems
•[SubscriptionItem!]!
non-null

The subscription items included in this subscription.

Anchor to legacySubscriptionIdlegacySubscriptionId
•ID

The ID of the legacy AppSubscription object accessible via Admin API.

Anchor to pendingUpdatependingUpdate
•PendingUpdate

Pending updates that will be applied at the next billing cycle. Returns null if no pending updates.

Anchor to shopshop
•ShopReference!
non-null

The shop that owns this subscription.

Anchor to trialEndsAttrialEndsAt
•DateTime

The date and time when the trial period ends. Returns null if no active trial.

Was this section helpful?