Charge

A charge made against a payment intent, such as an authorisation, capture or sale.

type Charge {
  amount: Money
  chargeType: ChargeType
  createdAt: ISO8601DateTime!
  customer: Customer!
  description: String
  exchangeRate: Float
  externalId: String
  failureCode: ChargeFailureCode
  failureMessage: String
  id: GlobalID!
  metadata: Metadata
  paymentIntent: PaymentIntent!
  recordStatus: RecordStatus
  refunds: [Refund!]
  source: ChargeSource
  status: ChargeStatus
  updatedAt: ISO8601DateTime
}

Fields

Charge.amount ● Money object types

The charge's amount, including any adjustments.

Charge.chargeType ● ChargeType enum types

The charge's type.

Charge.createdAt ● ISO8601DateTime! non-null scalar types

The date and time when the charge was created.

Charge.customer ● Customer! non-null object types

The customer the charge belongs to.

Charge.description ● String scalar types

The charge's description.

Charge.exchangeRate ● Float scalar types

The exchange rate from the shop's currency to the charge's currency.

Charge.externalId ● String scalar types

The charge's ID in an external system.

Charge.failureCode ● ChargeFailureCode enum types

The reason the charge failed.

Charge.failureMessage ● String scalar types

A message explaining why the charge failed.

Charge.id ● GlobalID! non-null scalar types

The charge's ID.

Charge.metadata ● Metadata scalar types

Key/value pairs for storing extra information about the charge.

Charge.paymentIntent ● PaymentIntent! non-null object types

The payment intent the charge belongs to.

Charge.recordStatus ● RecordStatus enum types

Whether Submarine processed the charge or recorded one processed elsewhere.

Charge.refunds ● [Refund!] list object types

The refunds made against the charge.

Charge.source ● ChargeSource enum types

The system that initiated the charge.

Charge.status ● ChargeStatus enum types

The charge's status.

Charge.updatedAt ● ISO8601DateTime scalar types

The date and time when the charge was last updated.

Returned By

charge query

Member Of

ChargeConnection object ● ChargeEdge object ● PaymentIntent object ● Refund object ● SubscriptionEvent object