Payment

This represents a payment made for an order

NameTypeNullable?Description
adjustments

Charge[]

A list of adjustments applied that influence the order total. For example, promotions/discounts/coupons. The amount should always be a quantity of currency, not a percentage.

amount_paidnumber

The amount of the currency

coupon_code

string

Coupon code applied to obtain a discount. The discount amounts should be included as one of the adjustments.

label_voucher

LabelVoucher

Represents information needed to leverage a third party Carrier API implementation

payment_idstring

An ID for this payment in the vendor API

payment_methodstring

The payment method

payment_status

PaymentStatus

The status of whether or not an order has been paid for

shipping_charges

Charge[]

A list of shipping charges.

taxes

Charge[]

A list of tax charges. The description can convey the jurisdiction