<!--
{
  "availability" : [

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

# ApplePayRecurringPaymentRequest

A dictionary that represents a request to set up a recurring payment, typically a subscription.

```
dictionary ApplePayRecurringPaymentRequest {
	required DOMString paymentDescription;
	required ApplePayLineItem regularBilling;
	ApplePayLineItem trialBilling;
	DOMString billingAgreement;
	required DOMString managementURL;
	DOMString tokenNotificationURL;
};
```

## Overview> Important:
> You must include the ``doc://com.apple.applepayontheweb/documentation/ApplePayontheWeb/ApplePayPaymentRequest/recurringPaymentRequest`` property in the ``doc://com.apple.applepayontheweb/documentation/ApplePayontheWeb/ApplePayPaymentRequest`` object to specify a request for a recurring payment.

Use an [`ApplePayRecurringPaymentRequest`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest) object to provide the user with payment details and a way to manage payment methods for a recurring payment. You can optionally display a billing agreement and set up merchant token life-cycle notifications for the request.

For more information about the merchant token life-cycle notifications, see <doc://com.apple.documentation/documentation/MerchantTokenNotificationServices>.

## Topics

### Describing the recurring payment

[`paymentDescription`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/paymentDescription)

A description of the recurring payment that Apple Pay displays to the user in the payment sheet.

[`billingAgreement`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/billingAgreement)

A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.

### Setting the payment summary items

[`regularBilling`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/regularBilling)

The regular billing cycle for the recurring payment, including start and end dates, an interval, and an interval count.

[`trialBilling`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/trialBilling)

The trial billing cycle for the recurring payment.

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

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

### Receiving payment token notifications

[`tokenNotificationURL`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/tokenNotificationURL)

A URL you provide for receiving life-cycle notifications from the Apple Pay servers about the Apple Pay merchant token for the recurring payment.

### Managing the recurring payment

[`managementURL`](/documentation/ApplePayontheWeb/ApplePayRecurringPaymentRequest/managementURL)

A URL to a web page where the user can update or delete the payment method for the recurring payment.


---

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)