SubscriptionEvent

Lifecycle event emitted when a subscription is created or its state changes.

type SubscriptionEvent {
  id: ID!
  type: String!
  accountId: ID!
  livemode: Boolean
  objectId: ID!
  objectType: String!
  object: SubscriptionEventObject!
  createdAt: AWSTimestamp
}

Fields

SubscriptionEvent.id ● ID! non-null scalar

Event ID.

SubscriptionEvent.type ● String! non-null scalar

Event type. subscription.pending on creation. On a status change: subscription.trialing, subscription.activated (also on resume and on recovery from PAST_DUE), subscription.past_due, subscription.paused or subscription.canceled. subscription.updated when amount, description, descriptor, customer, billingDetails, shippingDetails, interval, intervalCount, callbackUrl, paymentCallbackUrl, trialPeriodEnd, pauseAtPeriodEnd, pauseIntervalCount or cancelAtPeriodEnd changes without a status change, or when a prorated change settles.

SubscriptionEvent.accountId ● ID! non-null scalar

Owning merchant account ID.

SubscriptionEvent.livemode ● Boolean scalar

true for live mode, false for test mode.

SubscriptionEvent.objectId ● ID! non-null scalar

ID of the affected subscription.

SubscriptionEvent.objectType ● String! non-null scalar

Affected object type (always subscription).

SubscriptionEvent.object ● SubscriptionEventObject! non-null object

Subscription state at the moment the event was emitted.

SubscriptionEvent.createdAt ● AWSTimestamp scalar

Event time (unix timestamp, seconds).

Member Of

SubscriptionEventsConnection object