Skip to main content

Subscription

No description

type Subscription {
  id: ID!
  accountId: ID!
  livemode: Boolean!
  amount: Int!
  trialAmount: Int
  currency: Currencies
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  description: String
  descriptor: String
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  currentPeriodStart: Int
  currentPeriodEnd: Int
  trialPeriodDays: Int
  trialPeriodEnd: Int
  customerId: ID
  customer: Customer
  billingDetails: ContactDetails
  shippingDetails: ContactDetails
  sequenceId: ID
  lastOrderId: ID
  lastPayment: LastPayment
  paymentMethod: PaymentMethod
  nextPaymentAt: Int
  createdAt: Int
  updatedAt: Int
  interval: Interval!
  intervalCount: Int!
  retryCount: Int
  status: SubscriptionStatus!
  sessionDetails: SessionDetails
  traceDetails: TraceDetails
  callbackUrl: String
  paymentCallbackUrl: String
  storeId: ID
  retrySchedule: [RetrySchedule!]
  metadata: [KeyValueItem!]
}

Fields​

Subscription.id ● ID! non-null scalar​

Subscription.accountId ● ID! non-null scalar​

Subscription.livemode ● Boolean! non-null scalar​

Subscription.amount ● Int! non-null scalar​

Subscription.trialAmount ● Int scalar​

Subscription.currency ● Currencies enum​

Subscription.allowedPaymentMethods ● [SubscriptionPaymentMethods] list enum​

Subscription.description ● String scalar​

Subscription.descriptor ● String scalar​

Subscription.cancelAtPeriodEnd ● Boolean scalar​

Subscription.pauseIntervalCount ● Int scalar​

Subscription.pauseAtPeriodEnd ● Boolean scalar​

Subscription.skipIntervalCount ● Int scalar​

Subscription.currentPeriodStart ● Int scalar​

Subscription.currentPeriodEnd ● Int scalar​

Subscription.trialPeriodDays ● Int scalar​

Subscription.trialPeriodEnd ● Int scalar​

Subscription.customerId ● ID scalar​

Subscription.customer ● Customer object​

Subscription.billingDetails ● ContactDetails object​

Subscription.shippingDetails ● ContactDetails object​

Subscription.sequenceId ● ID scalar​

Subscription.lastOrderId ● ID scalar​

Subscription.lastPayment ● LastPayment object​

Subscription.paymentMethod ● PaymentMethod object​

Subscription.nextPaymentAt ● Int scalar​

Subscription.createdAt ● Int scalar​

Subscription.updatedAt ● Int scalar​

Subscription.interval ● Interval! non-null enum​

Subscription.intervalCount ● Int! non-null scalar​

Subscription.retryCount ● Int scalar​

Subscription.status ● SubscriptionStatus! non-null enum​

Subscription.sessionDetails ● SessionDetails object​

Subscription.traceDetails ● TraceDetails object​

Subscription.callbackUrl ● String scalar​

Subscription.paymentCallbackUrl ● String scalar​

Subscription.storeId ● ID scalar​

Subscription.retrySchedule ● [RetrySchedule!] list object​

Subscription.metadata ● [KeyValueItem!] list object​

Returned By​

cancelSubscription mutation ● createSubscription mutation ● pauseSubscription mutation ● resumeSubscription mutation ● sendSubscriptionLink mutation ● sendSubscriptionStatus mutation ● subscription query ● updateSubscription mutation

Member Of​

SubscriptionsConnection object