2013

Recurring Payments and Reference Transactions API Operations
GetRecurringPaymentsProfileDetails API Operation
12
210 February 01, 2013 SOAP API Developer Reference
BillingPeriodDetailsType Fields
StateOrProvince xs:string
State or province. Required for U.S. addresses only.
Character length and limitations: 40 single-byte characters
PostalCode xs:string
U.S. ZIP code or other country-specific postal code.
Character length and limitations: 20 single-byte characters
Country ebl:CountryCode
Country code.
Character length and limitations: 2 single-byte characters
Field Description
BillingPeriod ns:BillingPeriodType
Unit for billing during this 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 BillingPeriod and BillingFrequency cannot
exceed one year.
BillingFrequency xs:int
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.
TotalBillingCycles xs:int
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.
Field Description