CartPaymentMethod

Describes a cart payment method, including type, status, fees, and additional information.

Type Definition


type CartPaymentMethod {
  type: String
  title: String
  status: String
  isPaid: Boolean
  currency: Currency
  info: String
  description: String
  fee: Float
  netFee: Float
  tax: Float
  paidAmount: Float
  rate: Float
  ratePercentage: Float
  giftCard: GiftCard
  metafields: [Metafield]!
  metafield: Metafield
}

Fields

Field	Type	Description
type	String	Returns the type.
title	String	Returns the title.
status	String	Returns the status.
isPaid	Boolean	Returns true if this payment method status is paid.
currency	Currency	Returns payment method currency.
info	String	Returns additional information about the payment method.
description	String	Returns payment method description.
fee	Float	Returns the payment fee in customer’s currency.
netFee	Float	Returns the payment fee without tax in customer’s currency.
tax	Float	Returns the tax amount in customer’s currency.
paidAmount	Float	Returns the paid amount in customer’s currency.
rate	Float	Returns the tax rate in decimals.
ratePercentage	Float	Returns the tax rate.
giftCard	GiftCard	If this payment method type is gift_card this returns a GiftCard object with information about the gift card used as a payment method.
metafields	[Metafield]!	Metafields stored on this resource.
metafield	Metafield	A single metafield by namespace and key.

Relationships

CartPaymentMethod represents payment information within a cart context. It contains a reference to a Currency object that specifies the payment currency, and optionally references a GiftCard object if the payment method is a gift card. The type also includes metafield support for storing custom data associated with the payment method.

Example


{
  type
  title
  status
  isPaid
  currency {
    code
  }
  fee
  netFee
  tax
  paidAmount
  ratePercentage
  giftCard {
    id
    balance
  }
  metafields(first: 10) {
    edges {
      node {
        namespace
        key
        value
      }
    }
  }
}

Implements

No interfaces are implemented by this type.