Skip to main content

ChargeEvent

Audit log entry for a charge state change (creation, status update, refund, etc.).

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

Fields​

ChargeEvent.id ● ID! non-null scalar​

Event identifier.

ChargeEvent.type ● String! non-null scalar​

Event type, e.g. payment.created, payment.succeeded, payment.refunded.

ChargeEvent.accountId ● ID! non-null scalar​

Merchant account that owns the event.

ChargeEvent.livemode ● Boolean scalar​

true if the event came from a live charge, false for test mode.

ChargeEvent.objectId ● ID! non-null scalar​

Identifier of the related object. Currently always a charge id.

ChargeEvent.objectType ● String! non-null scalar​

Type of the related object. Currently always charge.

ChargeEvent.object ● ChargeEventObject! non-null object​

Snapshot of the charge at the time the event was emitted.

ChargeEvent.createdAt ● AWSTimestamp scalar​

Event time as a unix timestamp (seconds).

Member Of​

ChargeEventsConnection object