Skip to main content

CreateCheckoutInput

No description

input CreateCheckoutInput {
  provider: PaymentProvider!
  purpose: CheckoutPurpose!
  orgId: BigInt
  appId: BigInt
  tierId: BigInt
  planId: BigInt
  amountCents: BigInt
  currency: String
  successUrl: String
  cancelUrl: String
  idempotencyKey: String
}

Fields​

CreateCheckoutInput.provider ● PaymentProvider! non-null enum​

Payment processor to use for this checkout (STRIPE or PAYPAL).

CreateCheckoutInput.purpose ● CheckoutPurpose! non-null enum​

What the checkout is for; determines which other fields are required and the side effect applied on completion. DONATION and PROPERTY_TOKENS are rejected.

CreateCheckoutInput.orgId ● BigInt scalar​

Target organization (BigInt as a decimal string). Required for ORG_WALLET_TOPUP; ignored for other purposes.

CreateCheckoutInput.appId ● BigInt scalar​

Target app (BigInt as a decimal string). Required for APP_ACCESS_PURCHASE and SHARED_APP_SUBSCRIPTION.

CreateCheckoutInput.tierId ● BigInt scalar​

Access tier to purchase (BigInt as a decimal string). Required for APP_ACCESS_PURCHASE.

CreateCheckoutInput.planId ● BigInt scalar​

Shared-environment plan id (a shared_env_plans.plan_id, BigInt as a decimal string). Required for SHARED_APP_SUBSCRIPTION.

CreateCheckoutInput.amountCents ● BigInt scalar​

Charge amount in minor currency units (cents) of currency, as a BigInt decimal string. Required for ORG_WALLET_TOPUP.

CreateCheckoutInput.currency ● String scalar​

ISO-4217 currency code, lowercase (e.g. "usd"). Defaults to "usd".

CreateCheckoutInput.successUrl ● String scalar​

Absolute URL the provider redirects to after a successful payment. Optional; a server default is used if omitted.

CreateCheckoutInput.cancelUrl ● String scalar​

Absolute URL the provider redirects to if the user cancels. Optional; a server default is used if omitted.

CreateCheckoutInput.idempotencyKey ● String scalar​

Optional idempotency key. Recommended for retries: replaying with the same key and identical input returns the first checkout instead of opening a second provider session; the same key with different input returns IDEMPOTENCY_CONFLICT. Keys expire after 24h.

Member Of​

createCheckout mutation