Integration Guide
Table Of Contents
- Digital Goods Integration Guide - EC Edition
- Contents
- Preface
- Introducing Digital Goods for Express Checkout
- Integrating Digital Goods for Express Checkout
- Issuing Refunds
- Handling Recurring Payments
- How Recurring Payments Work
- Recurring Payments Terms
- Options for Creating a Recurring Payments Profile
- Recurring Payments With the Express Checkout API
- Recurring Payments Profile Status
- Getting Recurring Payments Profile Information
- Modifying a Recurring Payments Profile
- Billing the Outstanding Amount of a Profile
- Recurring Payments Notifications
- Options For Closing the Lightbox or Mini-browser
- Methods For Integrating Digital Goods Into Flash
- Express Checkout API Fields Supported By Digital Goods
- Revision History
Handling Recurring Payments
Options for Creating a Recurring Payments Profile
4
36 January 2012 Digital Goods Integration Guide - EC Edition
You can optionally include a value for TOTALBILLINGCYCLES (SOAP field
ScheduleDetails.PaymentPeriod.TotalBillingCycles), which specifies the total
number of billing cycles in the regular payment period. If you either do not specify a value or
specify the value 0, the payments continue until PayPal (or the buyer) cancels or suspends the
profile. If the value is greater than 0, the regular payment period continues for the specified
number of billing cycles.
You can also specify an optional shipping amount or tax amount for the regular payment
period.
Including an Optional Trial Period
You can optionally include a trial period in the profile by specifying the following fields in the
CreateRecurringPaymentsProfile request. The following table lists the required fields
for creating an optional trial period.
Required fields for specifying a trial period
Specifying an Initial Payment
You can optionally specify an initial non-recurring payment when the recurring payments
profile is created by including the following fields in the
CreateRecurringPaymentsProfile request:
BILLINGFREQUENCY ScheduleDetails.
PaymentPeriod.BillingFreque
ncy
The number of billing periods that make
up one billing cycle. The combination of
billing frequency and billing period must
be less than or equal to one year.
NOTE: If the billing period is
SemiMonth, the billing
frequency must be 1.
AMT ScheduleDetails.
PaymentPeriod.Amount
Amount to bill for each billing cycle.
NVP SOAP
TRIALBILLINGPERIOD ScheduleDetails.TrialPeriod.BillingPeriod
TRIALBILLINGFREQUENCY ScheduleDetails.TrialPeriod.BillingFrequency
TRIALAMT ScheduleDetails.TrialPeriod.Amount
TRIALTOTALBILLINGCYCLES ScheduleDetails.TrialPeriod.TotalBillingCycles
NVP SOAP Description