# 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[​](#fields "Direct link to Fields")

#### [`SubscriptionEventObject.id`](#id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#id "Direct link to id")

Unique identifier for the subscription.

#### [`SubscriptionEventObject.accountId`](#account-id) ● [`ID!`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) non-null scalar[​](#account-id "Direct link to account-id")

MONEI account identifier.

#### [`SubscriptionEventObject.createdAt`](#created-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#created-at "Direct link to created-at")

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

#### [`SubscriptionEventObject.updatedAt`](#updated-at) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#updated-at "Direct link to updated-at")

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

#### [`SubscriptionEventObject.amount`](#amount) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#amount "Direct link to amount")

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

#### [`SubscriptionEventObject.billingDetails`](#billing-details) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#billing-details "Direct link to billing-details")

Billing details.

#### [`SubscriptionEventObject.currency`](#currency) ● [`String!`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) non-null scalar[​](#currency "Direct link to currency")

Three-letter ISO 4217 currency code.

#### [`SubscriptionEventObject.allowedPaymentMethods`](#allowed-payment-methods) ● [`[SubscriptionPaymentMethods]`](https://docs.monei.com/apis/graphql/types/enums/subscription-payment-methods/.md) list enum[​](#allowed-payment-methods "Direct link to allowed-payment-methods")

List of payment methods allowed for subscriptions.

#### [`SubscriptionEventObject.customer`](#customer) ● [`Customer`](https://docs.monei.com/apis/graphql/types/objects/customer/.md) object[​](#customer "Direct link to customer")

Customer details.

#### [`SubscriptionEventObject.description`](#description) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#description "Direct link to description")

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

#### [`SubscriptionEventObject.descriptor`](#descriptor) ● [`String`](https://docs.monei.com/apis/graphql/types/scalars/string/.md) scalar[​](#descriptor "Direct link to descriptor")

Statement descriptor shown on the customer's bank statement.

#### [`SubscriptionEventObject.cancelAtPeriodEnd`](#cancel-at-period-end) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#cancel-at-period-end "Direct link to cancel-at-period-end")

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

#### [`SubscriptionEventObject.pauseIntervalCount`](#pause-interval-count) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#pause-interval-count "Direct link to pause-interval-count")

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

#### [`SubscriptionEventObject.pauseAtPeriodEnd`](#pause-at-period-end) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#pause-at-period-end "Direct link to pause-at-period-end")

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

#### [`SubscriptionEventObject.skipIntervalCount`](#skip-interval-count) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#skip-interval-count "Direct link to skip-interval-count")

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

#### [`SubscriptionEventObject.currentPeriodStart`](#current-period-start) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#current-period-start "Direct link to current-period-start")

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

#### [`SubscriptionEventObject.currentPeriodEnd`](#current-period-end) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#current-period-end "Direct link to current-period-end")

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

#### [`SubscriptionEventObject.trialPeriodDays`](#trial-period-days) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#trial-period-days "Direct link to trial-period-days")

Number of days the trial period lasts.

#### [`SubscriptionEventObject.trialPeriodEnd`](#trial-period-end) ● [`AWSTimestamp`](https://docs.monei.com/apis/graphql/types/scalars/awstimestamp/.md) scalar[​](#trial-period-end "Direct link to trial-period-end")

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

#### [`SubscriptionEventObject.livemode`](#livemode) ● [`Boolean`](https://docs.monei.com/apis/graphql/types/scalars/boolean/.md) scalar[​](#livemode "Direct link to livemode")

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

#### [`SubscriptionEventObject.storeId`](#store-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#store-id "Direct link to store-id")

Related store ID.

#### [`SubscriptionEventObject.pointOfSaleId`](#point-of-sale-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#point-of-sale-id "Direct link to point-of-sale-id")

Related point-of-sale ID.

#### [`SubscriptionEventObject.sequenceId`](#sequence-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#sequence-id "Direct link to sequence-id")

A unique identifier representing a series of subsequent recurring payments.

#### [`SubscriptionEventObject.lastOrderId`](#last-order-id) ● [`ID`](https://docs.monei.com/apis/graphql/types/scalars/id/.md) scalar[​](#last-order-id "Direct link to last-order-id")

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

#### [`SubscriptionEventObject.lastPayment`](#last-payment) ● [`LastPayment`](https://docs.monei.com/apis/graphql/types/objects/last-payment/.md) object[​](#last-payment "Direct link to last-payment")

Details of the last payment for the subscription.

#### [`SubscriptionEventObject.paymentMethod`](#payment-method) ● [`PaymentMethod`](https://docs.monei.com/apis/graphql/types/objects/payment-method/.md) object[​](#payment-method "Direct link to payment-method")

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

#### [`SubscriptionEventObject.shippingDetails`](#shipping-details) ● [`ContactDetails`](https://docs.monei.com/apis/graphql/types/objects/contact-details/.md) object[​](#shipping-details "Direct link to shipping-details")

Shipping details.

#### [`SubscriptionEventObject.status`](#status) ● [`SubscriptionStatus!`](https://docs.monei.com/apis/graphql/types/enums/subscription-status/.md) non-null enum[​](#status "Direct link to status")

The status of the subscription.

#### [`SubscriptionEventObject.traceDetails`](#trace-details) ● [`TraceDetails`](https://docs.monei.com/apis/graphql/types/objects/trace-details/.md) object[​](#trace-details "Direct link to trace-details")

Tracing details of the triggering action.

#### [`SubscriptionEventObject.interval`](#interval) ● [`Interval!`](https://docs.monei.com/apis/graphql/types/enums/interval/.md) non-null enum[​](#interval "Direct link to interval")

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

#### [`SubscriptionEventObject.intervalCount`](#interval-count) ● [`Int!`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) non-null scalar[​](#interval-count "Direct link to interval-count")

Number of intervals between subscription payments.

#### [`SubscriptionEventObject.retryCount`](#retry-count) ● [`Int`](https://docs.monei.com/apis/graphql/types/scalars/int/.md) scalar[​](#retry-count "Direct link to retry-count")

Number of retries left for the subscription.

#### [`SubscriptionEventObject.metadata`](#metadata) ● [`[KeyValueItem!]`](https://docs.monei.com/apis/graphql/types/objects/key-value-item/.md) list object[​](#metadata "Direct link to metadata")

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

### Member Of[​](#member-of "Direct link to Member Of")

[`SubscriptionEvent`](https://docs.monei.com/apis/graphql/types/objects/subscription-event/.md) object