<!--
{
  "availability" : [

  ],
  "documentType" : "symbol",
  "framework" : "ApplePayontheWeb",
  "identifier" : "/documentation/ApplePayontheWeb/ApplePayLineItem",
  "metadataVersion" : "0.1.0",
  "role" : "Structure",
  "symbol" : {
    "kind" : "Structure",
    "modules" : [
      "Apple Pay on the Web"
    ],
    "preciseIdentifier" : "struct/ApplePayLineItem"
  },
  "title" : "ApplePayLineItem"
}
-->

# ApplePayLineItem

A line item in a payment request—for example, total, tax, discount, or grand total.

```
dictionary ApplePayLineItem {
	ApplePayLineItemType type;
	DOMString label;
	DOMString amount;
	ApplePayPaymentTiming paymentTiming;
	Date recurringPaymentStartDate;
	ApplePayRecurringPaymentDateUnit recurringPaymentIntervalUnit;
	long recurringPaymentIntervalCount;
	Date recurringPaymentEndDate;
	Date deferredPaymentDate;
	DOMString automaticReloadPaymentThresholdAmount;
};
```

## Overview

Line items appear in the payment sheet.

The following code is an example of a line item for a $20 charge that recurs every six months starting on 01/01/2022 and ending on 01/01/2024:

```javascript
{
    "label": "Subscription",
    "amount": "20.00",
    "type": "final",
    "paymentTiming": "recurring",
    "recurringPaymentStartDate": new Date("2022-01-01T00:00:00"),
    "recurringPaymentIntervalUnit": "month",
    "recurringPaymentIntervalCount": 6,
    "recurringPaymentEndDate": new Date("2024-01-01T00:00:00"),
}
```

The following code is an example of a line item for a deferred charge of $50 on 07/01/2023:

```javascript
{
    "label": "After Trial Period",
    "amount": "50.00",
    "type": "final",
    "paymentTiming": "deferred",
    "deferredPaymentDate": new Date("2023-07-01T00:00:00"),
}
```

For examples of line items within an [`ApplePayPaymentRequest`](/documentation/ApplePayontheWeb/ApplePayPaymentRequest), see [`lineItems`](/documentation/ApplePayontheWeb/ApplePayPaymentRequest/lineItems) and [`total`](/documentation/ApplePayontheWeb/ApplePayPaymentRequest/total).

## Topics

### Setting line item properties

[`label`](/documentation/ApplePayontheWeb/ApplePayLineItem/label)

A required value that’s a short, localized description of the line item.

[`amount`](/documentation/ApplePayontheWeb/ApplePayLineItem/amount)

A required value that’s the monetary amount of the line item.

[`type`](/documentation/ApplePayontheWeb/ApplePayLineItem/type)

A value that indicates whether the line item is final or pending.

[`ApplePayLineItemType`](/documentation/ApplePayontheWeb/ApplePayLineItemType)

A type that indicates whether a line item is final or pending.

### Configuring payment timing

[`paymentTiming`](/documentation/ApplePayontheWeb/ApplePayLineItem/paymentTiming)

The time that the payment occurs as part of a successful transaction.

[`ApplePayPaymentTiming`](/documentation/ApplePayontheWeb/ApplePayPaymentTiming)

A type that indicates the time a payment occurs in a transaction.

### Configuring recurring payments

[`recurringPaymentStartDate`](/documentation/ApplePayontheWeb/ApplePayLineItem/recurringPaymentStartDate)

The date of the first payment.

[`recurringPaymentEndDate`](/documentation/ApplePayontheWeb/ApplePayLineItem/recurringPaymentEndDate)

The date of the final payment.

[`recurringPaymentIntervalUnit`](/documentation/ApplePayontheWeb/ApplePayLineItem/recurringPaymentIntervalUnit)

The amount of time — in calendar units, such as day, month, or year — that represents a fraction of the total payment interval.

[`recurringPaymentIntervalCount`](/documentation/ApplePayontheWeb/ApplePayLineItem/recurringPaymentIntervalCount)

The number of interval units that make up the total payment interval.

[`ApplePayRecurringPaymentDateUnit`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentDateUnit)

A type that indicates calendrical units, such as year, month, day, and hour.

### Configuring deferred payments

[`deferredPaymentDate`](/documentation/ApplePayontheWeb/ApplePayLineItem/deferredPaymentDate)

The date, in the future, of the payment.

### Configuring automatic reload payments

[`automaticReloadPaymentThresholdAmount`](/documentation/ApplePayontheWeb/ApplePayLineItem/automaticReloadPaymentThresholdAmount)

The balance an account reaches before the merchant applies the automatic reload amount.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)