Skip to main content

SubscriptionEventObject

Subscription snapshot embedded in a SubscriptionEvent.

type SubscriptionEventObject {
  id: ID!
  accountId: ID!
  createdAt: AWSTimestamp
  updatedAt: AWSTimestamp
  amount: Int
  billingDetails: ContactDetails
  currency: String!
  allowedPaymentMethods: [SubscriptionPaymentMethods]
  customer: Customer
  description: String
  descriptor: String
  cancelAtPeriodEnd: Boolean
  pauseIntervalCount: Int
  pauseAtPeriodEnd: Boolean
  skipIntervalCount: Int
  currentPeriodStart: AWSTimestamp
  currentPeriodEnd: AWSTimestamp
  trialPeriodDays: Int
  trialPeriodEnd: AWSTimestamp
  livemode: Boolean
  storeId: ID
  pointOfSaleId: ID
  sequenceId: ID
  lastOrderId: ID
  lastPayment: LastPayment
  paymentMethod: PaymentMethod
  shippingDetails: ContactDetails
  status: SubscriptionStatus!
  traceDetails: TraceDetails
  interval: Interval!
  intervalCount: Int!
  retryCount: Int
  metadata: [KeyValueItem!]
}

Fields

`SubscriptionEventObject.id` ● `ID!` non-null scalar

Unique identifier for the subscription.

`SubscriptionEventObject.accountId` ● `ID!` non-null scalar

MONEI account identifier.

`SubscriptionEventObject.createdAt` ● `AWSTimestamp` scalar

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

`SubscriptionEventObject.updatedAt` ● `AWSTimestamp` scalar

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

`SubscriptionEventObject.amount` ● `Int` scalar

A positive integer representing how much to charge in the smallest currency unit.

`SubscriptionEventObject.billingDetails` ● `ContactDetails` object

Billing details.

`SubscriptionEventObject.currency` ● `String!` non-null scalar

Three-letter ISO 4217 currency code.

`SubscriptionEventObject.allowedPaymentMethods` ● `[SubscriptionPaymentMethods]` list enum

List of payment methods allowed for subscriptions.

`SubscriptionEventObject.customer` ● `Customer` object

Customer details.

`SubscriptionEventObject.description` ● `String` scalar

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

`SubscriptionEventObject.descriptor` ● `String` scalar

Statement descriptor shown on the customer's bank statement.

`SubscriptionEventObject.cancelAtPeriodEnd` ● `Boolean` scalar

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

`SubscriptionEventObject.pauseIntervalCount` ● `Int` scalar

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

`SubscriptionEventObject.pauseAtPeriodEnd` ● `Boolean` scalar

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

`SubscriptionEventObject.skipIntervalCount` ● `Int` scalar

The number of intervals during which the subscription billing cycle will be skipped without altering the subscription status.

`SubscriptionEventObject.currentPeriodStart` ● `AWSTimestamp` scalar

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

`SubscriptionEventObject.currentPeriodEnd` ● `AWSTimestamp` scalar

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

`SubscriptionEventObject.trialPeriodDays` ● `Int` scalar

Number of days the trial period lasts.

`SubscriptionEventObject.trialPeriodEnd` ● `AWSTimestamp` scalar

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

`SubscriptionEventObject.livemode` ● `Boolean` scalar

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

`SubscriptionEventObject.storeId` ● `ID` scalar

Related store ID.

`SubscriptionEventObject.pointOfSaleId` ● `ID` scalar

Related point-of-sale ID.

`SubscriptionEventObject.sequenceId` ● `ID` scalar

A unique identifier representing a series of subsequent recurring payments.

`SubscriptionEventObject.lastOrderId` ● `ID` scalar

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

`SubscriptionEventObject.lastPayment` ● `LastPayment` object

Details of the last payment for the subscription.

`SubscriptionEventObject.paymentMethod` ● `PaymentMethod` object

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

`SubscriptionEventObject.shippingDetails` ● `ContactDetails` object

Shipping details.

`SubscriptionEventObject.status` ● `SubscriptionStatus!` non-null enum

The status of the subscription.

`SubscriptionEventObject.traceDetails` ● `TraceDetails` object

Tracing details of the triggering action.

`SubscriptionEventObject.interval` ● `Interval!` non-null enum

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

`SubscriptionEventObject.intervalCount` ● `Int!` non-null scalar

Number of intervals between subscription payments.

`SubscriptionEventObject.retryCount` ● `Int` scalar

Number of retries left for the subscription.

`SubscriptionEventObject.metadata` ● `[KeyValueItem!]` list object

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

Member Of

SubscriptionEvent object

Fields
Member Of