Skip to main content

PaymentRuleField

A field a payment rule condition may reference. path is the value to use in a condition's var; the same list is enforced when a rule is created or updated.

type PaymentRuleField {
path: String!
valueType: PaymentRuleFieldValueType!
enumValues: [String!]
}

Fields

PaymentRuleField.path ● String! non-null scalar

Dotted path usable in a condition, e.g. paymentMethod.card.brand.

PaymentRuleField.valueType ● PaymentRuleFieldValueType! non-null enum

Kind of value the field holds.

PaymentRuleField.enumValues ● [String!] list scalar

Allowed values when valueType is ENUM; absent otherwise.

Member Of

PaymentRuleFieldRegistry object