2012

Name-Value Pair API Developer Guide August 2012 149
Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API Operation
12
REGULARBILLINGPERIO
D
Unit for billing during this regular subscription period. It is one of the following
values:
 Day
 Week
 SemiMonth
 Month
 Year
For SemiMonth, billing is done on the 1st and 15th of each month.
NOTE: The combination of RegularBillingPeriod and
RegularBillingFrequency cannot exceed one year.
This field is available since version 53.0.
BILLINGFREQUENCY 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. For example, if
the billing cycle is Month, the maximum value for billing frequency is 12. Similarly,
if the billing cycle is Week, the maximum value for billing frequency is 52.
NOTE: If the billing period is SemiMonth., the billing frequency must be 1.
REGULARBILLINGFREQU
ENCY
Number of billing periods that make up one regular billing cycle.
The combination of billing frequency and billing period must be less than or equal to
one year. For example, if the billing cycle is Month, the maximum value for billing
frequency is 12. Similarly, if the billing cycle is Week, the maximum value for billing
frequency is 52.
NOTE: If the billing period is SemiMonth., the billing frequency must be 1.
This field is available since version 53.0.
TOTALBILLINGCYCLES Number of billing cycles for payment period (either the regular payment period or the
trial period).
 For the trial period, the value must be greater than 0.
 For the regular payment period, if no value is specified or the value is 0, the
regular payment period continues until the profile is canceled or deactivated.
 For the regular payment period, if the value is greater than 0, the regular payment
period will expire after the trial period is finished and continue at the billing
frequency for TotalBillingCycles cycles.
REGULARTOTALBILLING
CYCLES
Number of billing cycles for the regular payment period.
 For the regular payment period, if no value is specified or the value is 0, the
regular payment period continues until the profile is canceled or deactivated.
 For the regular payment period, if the value is greater than 0, the regular payment
period will expire after the trial period is finished and continue at the billing
frequency for RegularTotalBillingCycles cycles.
This field is available since version 53.0.
Field Description