Cancelled
Represents a pricing subscription that was cancelled.
Anchor to FieldsFields
- app (AppReference!)
- billingPeriod (AppPricingInterval!)
- cancelAtEndOfCycle (Boolean!)
- cancelledAt (DateTime)
- currentBillingCycle (BillingCycle)
- items ([SubscriptionItem!]!)
- legacySubscriptionId (ID)
- pendingUpdate (PendingUpdate)
- shop (ShopReference!)
- trialEndsAt (DateTime)
- •App
Reference! non-null The app that provides this subscription.
- Anchor to billingPeriodbilling•App
Period Pricing Interval! non-null The frequency at which the shop is billed for an app subscription.
- Anchor to cancelAtEndOfCyclecancel•Boolean!
At End Of Cycle non-null Returns true if the subscription will be cancelled at the end of the cycle.
- Anchor to cancelledAtcancelled•Date
At Time The date and time when the subscription was cancelled. Returns null for deferred cancellations.
- Anchor to currentBillingCyclecurrent•Billing
Billing Cycle Cycle The current billing cycle for the subscription. Returns null if the subscription is still in trial.
- Anchor to itemsitems•[Subscription
Item!]! non-null The subscription items included in this subscription.
- Anchor to legacySubscriptionIdlegacy•ID
Subscription Id The ID of the legacy AppSubscription object accessible via Admin API.
- Anchor to pendingUpdatepending•Pending
Update Update Pending updates that will be applied at the next billing cycle. Returns null if no pending updates.
- Anchor to shopshop•Shop
Reference! non-null The shop that owns this subscription.
- Anchor to trialEndsAttrial•Date
Ends At Time The date and time when the trial period ends. Returns null if no active trial.
Anchor to MutationsMutations
- appSubscriptionCancel (AppSubscriptionCancelPayload)
- •mutation
Cancels an app subscription.
- Anchor to appIdapp•ID!
Id required The id of the app. Example value:
.- Anchor to deferCancellationdefer•Boolean!
Cancellation required Whether to defer cancellation until the end of the current billing cycle.
- Anchor to prorateprorate•Boolean!required
Whether to issue prorated credits for the unused portion of the subscription. Cannot be used together with
.- Anchor to shopIdshop•ID!
Id required The id of the shop. Example value:
.- Anchor to skipFinalUsageChargeskip•Boolean!
Final Usage Charge required Whether to skip the final usage charge when cancelling. Only applicable to usage-billed subscriptions. Cannot be used together with
prorate.
Arguments