2013

Recurring Payments and Reference Transactions API Operations
CreateRecurringPaymentsProfile API Operation
12
194 February 01, 2013 SOAP API Developer Reference
TrialPeriod.Billing
Period
ns:BillingPeriodType
Unit for billing during this subscription period; required if you specify an optional
trial 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 BillingPeriod and BillingFrequency cannot
exceed one year.
TrialPeriod.Billing
Frequency
xs:int
Number of billing periods that make up one billing cycle; required if you specify an
optional trial period.
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.
TrialPeriod.TotalBi
llingCycles
xs:int
(Optional) Number of billing cycles for trial payment period.
TrialPeriod.Amount cc:BasicAmountType
Billing amount for each billing cycle during this payment period; required if you
specify an optional trial period. This amount does not include shipping and tax
amounts.
NOTE: All amounts in the CreateRecurringPaymentsProfile request must
have the same currency.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
ShippingAmount cc:BasicAmountType
(Optional) Shipping amount for each billing cycle during this payment period.
NOTE: All amounts in the request must have the same currency.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2 decimal
places, the decimal separator must be a period (.), and the optional thousands
separator must be a comma (,).
Field Description