App
Provides users access to services and/or features for a duration of time.
Anchor to FieldsFields
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the app subscription was created.
- Anchor to currentPeriodEndcurrent•
Period End The date and time when the current app subscription period ends. Returns
nullif the subscription isn't active.- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•
Items [AppSubscription Line Item!]!non-null The plans attached to the app subscription.
- Anchor to namename•String!non-null
The name of the app subscription.
- Anchor to returnUrlreturn•
Url URL!non-null The URL that the merchant is redirected to after approving the app subscription.
- Anchor to statusstatus•App
Subscription Status!non-null The status of the app subscription.
- Anchor to testtest•Boolean!non-null
Specifies whether the app subscription is a test transaction.
- Anchor to trialDaystrial•
Days Int!non-null The number of free trial days, starting at the subscription's creation date, by which billing is delayed.
Anchor to MutationsMutations
- •mutation
Cancels an app subscription on a store.
- •ID!required
The ID of the app subscription to be cancelled.
- Anchor to prorateprorate•BooleanDefault:false
Whether to issue prorated credits for the unused portion of the app subscription. There will be a corresponding deduction (based on revenue share) to your Partner account. For example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way through the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted from your Partner account.
Arguments
- Anchor to appSubscriptionapp•
Subscription The cancelled app subscription.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Allows an app to charge a store for features or services on a recurring basis.
- Anchor to lineItemsline•
Items [AppSubscription Line Item Input!]!required Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type.
- Anchor to namename•String!required
A descriptive name for the app subscription.
- Anchor to replacementBehaviorreplacement•
Behavior AppSubscription Replacement BehaviorDefault:STANDARD The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.
- Anchor to returnUrlreturn•
Url URL!required The URL pointing to the page where the merchant is redirected after approving the app subscription.
- Anchor to testtest•BooleanDefault:false
Whether the app subscription is a test transaction.
- Anchor to trialDaystrial•
Days The number of days of the free trial period, beginning on the day that the merchant approves the app charges.
Arguments
- Anchor to appSubscriptionapp•
Subscription The newly-created app subscription.
- Anchor to confirmationUrlconfirmation•
Url The URL pointing to the page where the merchant approves or declines the charges for an app subscription.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates the capped amount on the usage pricing plan of an app subscription line item.
- Anchor to cappedAmountcapped•
Amount MoneyInput!required The new maximum amount of usage charges that can be incurred within a subscription billing interval.
- •ID!required
The ID of the app subscription line item to be updated.
Arguments
- Anchor to appSubscriptionapp•
Subscription The updated app subscription.
- Anchor to confirmationUrlconfirmation•
Url The URL where the merchant approves or declines the updated app subscription line item.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Extends the trial of an app subscription.
- Anchor to daysdays•Int!required
The number of days to extend the trial. The value must be greater than 0 and less than or equal to 1000.
- •ID!required
The ID of the app subscription to extend the trial for.
Arguments
- Anchor to appSubscriptionapp•
Subscription The app subscription that had its trial extended.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields