Subscription

Recurring subscription billing a customer on a fixed cadence.

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: AWSTimestamp
  currentPeriodEnd: AWSTimestamp
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  customerId: ID
  customer: Customer
  billingDetails: ContactDetails
  shippingDetails: ContactDetails
  sequenceId: ID
  lastOrderId: ID
  lastPayment: LastPayment
  paymentMethod: PaymentMethod
  nextPaymentAt: AWSTimestamp
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  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

Unique identifier for the subscription.

Subscription.accountId ● ID! non-null scalar

MONEI account identifier.

Subscription.livemode ● Boolean! non-null scalar

Whether the subscription was created in live mode (true) or test mode (false).

Subscription.amount ● Int! non-null scalar

A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge 1.00 USD).

Subscription.trialAmount ● Int scalar

Amount charged during the trial period in minor units. null/0 means free trial.

Subscription.currency ● Currencies enum

Three-letter ISO 4217 currency code.

Subscription.allowedPaymentMethods ● [SubscriptionPaymentMethods] list enum

List of payment methods allowed for subscriptions.

Subscription.description ● String scalar

An arbitrary string attached to the subscription. Often useful for displaying to users.

Subscription.descriptor ● String scalar

Statement descriptor shown on the customer's bank statement.

Subscription.cancelAtPeriodEnd ● Boolean scalar

If true, the subscription will be canceled at the end of the current period.

Subscription.pauseIntervalCount ● Int scalar

Number of intervals when subscription will be paused before it activates again.

Subscription.pauseAtPeriodEnd ● Boolean scalar

If true, the subscription will be paused at the end of the current period.

Subscription.skipIntervalCount ● Int scalar

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status. Useful when payment for a specific period is received through different methods.

Subscription.currentPeriodStart ● AWSTimestamp scalar

The start date of the current subscription period. Measured in seconds since the Unix epoch.

Subscription.currentPeriodEnd ● AWSTimestamp scalar

The end date of the current subscription period. Measured in seconds since the Unix epoch.

Subscription.trialPeriodDays ● Int scalar

Number of days the trial period lasts.

Subscription.trialPeriodEnd ● AWSTimestamp scalar

The end date of the trial period. Measured in seconds since the Unix epoch.

Subscription.customerId ● ID scalar

Customer identifier associated with the subscription.

Subscription.customer ● Customer object

Customer details.

Subscription.billingDetails ● ContactDetails object

Billing details.

Subscription.shippingDetails ● ContactDetails object

Shipping details.

Subscription.sequenceId ● ID scalar

A unique identifier representing a series of subsequent recurring payments.

Subscription.lastOrderId ● ID scalar

An order ID created by your system that is attached to the last subscription payment.

Subscription.lastPayment ● LastPayment object

Details of the last payment for the subscription.

Subscription.paymentMethod ● PaymentMethod object

Details about the payment method at the time of the transaction.

Subscription.nextPaymentAt ● AWSTimestamp scalar

The date when the next payment will be made.

Subscription.createdAt ● AWSTimestamp scalar

Time at which the subscription was created. Measured in seconds since the Unix epoch.

Subscription.updatedAt ● AWSTimestamp scalar

Time at which the subscription was last updated. Measured in seconds since the Unix epoch.

Subscription.interval ● Interval! non-null enum

Subscription interval. The minute and hour intervals are only available in test mode.

Subscription.intervalCount ● Int! non-null scalar

Number of intervals between subscription payments.

Subscription.retryCount ● Int scalar

Number of retries left for the subscription.

Subscription.status ● SubscriptionStatus! non-null enum

The status of the subscription.

Subscription.sessionDetails ● SessionDetails object

Browser/device fingerprint captured at activation.

Subscription.traceDetails ● TraceDetails object

Tracing details of the action that created or modified the subscription.

Subscription.callbackUrl ● String scalar

The URL will be called each time subscription status changes. You will receive a subscription object in the body of the request.

Subscription.paymentCallbackUrl ● String scalar

The URL will be called each time subscription creates a new payment. You will receive the payment object in the body of the request.

Subscription.storeId ● ID scalar

Related store ID.

Subscription.retrySchedule ● [RetrySchedule!] list object

Defines a custom schedule for retrying failed subscription payments. If not specified, the system's default retry schedule will be used.

Subscription.metadata ● [KeyValueItem!] list object

A set of key-value pairs attached to the subscription.

Returned By

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

Member Of

SubscriptionsConnection object