Checkout

No description

type Checkout {
  checkoutId: BigInt!
  userId: BigInt!
  provider: PaymentProvider!
  purpose: CheckoutPurpose!
  status: CheckoutStatus!
  amountCents: BigInt
  currency: String
  externalId: String!
  externalUrl: String!
  orgId: BigInt
  appId: BigInt
  tierId: BigInt
  error: String
  createdAt: DateTime!
  completedAt: DateTime
  expiresAt: DateTime
}

Fields

Checkout.checkoutId ● BigInt! non-null scalar

Unique checkout id (BigInt as a decimal string).

Checkout.userId ● BigInt! non-null scalar

User who initiated the checkout (BigInt as a decimal string).

Checkout.provider ● PaymentProvider! non-null enum

Payment processor handling this checkout.

Checkout.purpose ● CheckoutPurpose! non-null enum

Why the checkout was created; determines the side effect applied on completion.

Checkout.status ● CheckoutStatus! non-null enum

Current lifecycle state, updated by webhook reconciliation (not by the redirect).

Checkout.amountCents ● BigInt scalar

Charge amount in minor currency units (cents) of currency, as a BigInt decimal string; null when the purpose carries no amount.

Checkout.currency ● String scalar

ISO-4217 currency code for amountCents, lowercase (e.g. "usd"); null when no amount applies.

Checkout.externalId ● String! non-null scalar

Identifier of the session/order in the provider (e.g. Stripe Checkout Session id, PayPal Order id).

Checkout.externalUrl ● String! non-null scalar

Provider-hosted URL to redirect the user to in order to complete payment.

Checkout.orgId ● BigInt scalar

Target organization for the purpose (BigInt as a decimal string); null when not applicable.

Checkout.appId ● BigInt scalar

Target app for the purpose (BigInt as a decimal string); null when not applicable.

Checkout.tierId ● BigInt scalar

Access tier being purchased (BigInt as a decimal string); set for APP_ACCESS_PURCHASE, otherwise null.

Checkout.error ● String scalar

Failure reason when status is FAILED; null otherwise.

Checkout.createdAt ● DateTime! non-null scalar

When the checkout was created (ISO-8601 UTC timestamp).

Checkout.completedAt ● DateTime scalar

When the checkout reached COMPLETED (ISO-8601 UTC timestamp); null until then.

Checkout.expiresAt ● DateTime scalar

When the provider session expires if still unpaid (ISO-8601 UTC timestamp); null if there is no expiry.

Returned By

capturePaypalCheckout mutation ● createCheckout mutation

Member Of

CheckoutEdge object ● CheckoutsPage object ● PublishAppResult object