Preview

SurchargeAdditionalCharge is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

SurchargeAdditionalCharge

A surcharge applied when the customer pays by credit card

This page contains

    Fields

    id: ID!

    Unique identifier of the additional charge

    lineNumber: Int

    Line number used to correlate this charge with the invoice tax report

    type: AdditionalChargeType! PREVIEW

    Type of additional charge

    amount: Decimal!

    Charge amount in the invoice currency

    description: String

    Human-readable description of the charge

    metadata: JSON

    Additional key-value metadata for the charge

    rate: String

    Surcharge rate as a decimal string (for example, 0.03 for 3%)

    Implements