We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

AppSubscription

Version 2019-07 (Latest)

Provides users access to services and/or features for a duration of time.

Show definition
"""
Provides users access to services and/or features for a duration of time.
"""
type AppSubscription implements Node {
  """
  The date and time when the app subscription was created.
  """
  createdAt: DateTime!
  """
  The date and time when the current app subscription period ends.
  """
  currentPeriodEnd: DateTime
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Attaches a plan to an app subscription.
  """
  lineItems: [AppSubscriptionLineItem!]!
  """
  The name of the app subscription.
  """
  name: String!
  """
  The URL where the merchant is redirected after approving the app subscription.
  """
  returnUrl: URL!
  """
  The status of the app subscription. Possible values include pending, active, declined,
           expired, frozen, and cancelled.
  """
  status: AppSubscriptionStatus!
  """
  Specifies whether the app subscription is a test transaction.
  """
  test: Boolean!
  """
  The number of days of the free trial.
  """
  trialDays: Int!
}

Implements

Fields

createdAt (DateTime!)

The date and time when the app subscription was created.

currentPeriodEnd (DateTime)

The date and time when the current app subscription period ends.

id (ID!)

Globally unique identifier.

lineItems ([AppSubscriptionLineItem!]!)

Attaches a plan to an app subscription.

name (String!)

The name of the app subscription.

returnUrl (URL!)

The URL where the merchant is redirected after approving the app subscription.

status (AppSubscriptionStatus!)

The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.

test (Boolean!)

Specifies whether the app subscription is a test transaction.

trialDays (Int!)

The number of days of the free trial.

Version 2019-10 (Release candidate)

Provides users access to services and/or features for a duration of time.

Show definition
"""
Provides users access to services and/or features for a duration of time.
"""
type AppSubscription implements Node {
  """
  The date and time when the app subscription was created.
  """
  createdAt: DateTime!
  """
  The date and time when the current app subscription period ends.
  """
  currentPeriodEnd: DateTime
  """
  Globally unique identifier.
  """
  id: ID!
  """
  Attaches a plan to an app subscription.
  """
  lineItems: [AppSubscriptionLineItem!]!
  """
  The name of the app subscription.
  """
  name: String!
  """
  The URL where the merchant is redirected after approving the app subscription.
  """
  returnUrl: URL!
  """
  The status of the app subscription. Possible values include pending, active, declined,
           expired, frozen, and cancelled.
  """
  status: AppSubscriptionStatus!
  """
  Specifies whether the app subscription is a test transaction.
  """
  test: Boolean!
  """
  The number of days of the free trial.
  """
  trialDays: Int!
}

Implements

Fields

createdAt (DateTime!)

The date and time when the app subscription was created.

currentPeriodEnd (DateTime)

The date and time when the current app subscription period ends.

id (ID!)

Globally unique identifier.

lineItems ([AppSubscriptionLineItem!]!)

Attaches a plan to an app subscription.

name (String!)

The name of the app subscription.

returnUrl (URL!)

The URL where the merchant is redirected after approving the app subscription.

status (AppSubscriptionStatus!)

The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.

test (Boolean!)

Specifies whether the app subscription is a test transaction.

trialDays (Int!)

The number of days of the free trial.

Sign up for a Partner account to get started.

Sign up