Skip to main content

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 (e.g. subscription.created, subscription.updated, subscription.canceled).

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