SubscriptionEvent

A record of an action on a subscription or one of its related resources, such as a subscription order or discount.

type SubscriptionEvent {
  action: SubscriptionEventAction!
  charge: Charge
  createdAt: Timestamp!
  customer: Customer
  description: String
  diff: [EventDiff!]!
  id: GlobalID!
  milestone: EventMilestone
  paymentIntent: PaymentIntent
  status: EventStatus!
  subscription: Subscription
  subscriptionDiscount: SubscriptionDiscount
  subscriptionOrder: SubscriptionOrder
}

Fields

SubscriptionEvent.action ● SubscriptionEventAction! non-null enum types

The action the event records.

SubscriptionEvent.charge ● Charge object types

The charge related to the event, if any.

SubscriptionEvent.createdAt ● Timestamp! non-null scalar types

The date and time when the subscription event was created.

SubscriptionEvent.customer ● Customer object types

The customer the event relates to.

SubscriptionEvent.description ● String scalar types

The description given with the action, such as a reason for cancelling.

SubscriptionEvent.diff ● [EventDiff!]! non-null object types

The changes the action made.

SubscriptionEvent.id ● GlobalID! non-null scalar types

The subscription event's ID.

SubscriptionEvent.milestone ● EventMilestone enum types

The stage of the action the event records, for actions with several stages.

SubscriptionEvent.paymentIntent ● PaymentIntent object types

The payment intent related to the event, if any.

SubscriptionEvent.status ● EventStatus! non-null enum types

Whether the action succeeded or failed.

SubscriptionEvent.subscription ● Subscription object types

The subscription the event relates to.

SubscriptionEvent.subscriptionDiscount ● SubscriptionDiscount object types

The subscription discount the event relates to.

SubscriptionEvent.subscriptionOrder ● SubscriptionOrder object types

The subscription order the event relates to.

Member Of

Subscription object ● SubscriptionEventConnection object ● SubscriptionEventEdge object ● SubscriptionOrder object