2009

Name-Value Pair API Developer Guide 08 April 2009 119
Recurring Payments and Reference Transactions API Operations
UpdateRecurringPaymentsProfile API
Ship To Address Fields
Billing Period Details Type
Field Description
SHIPTONAME Person’s name associated with this address. This field is required for
shipping addresses but is optional for credit card billing addresses.
Character length and limitations: 32 single-byte characters.
SHIPTOSTREET First street address. This field is required if the shipping address is used.
Character length and limitations: 100 single-byte characters.
SHIPTOSTREET2 (Optional) Second street address.
Character length and limitations: 100 single-byte characters.
SHIPTOCITY Name of city. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
SHIPTOSTATE State or province. This field is required if the shipping address is used.
Character length and limitations: 40 single-byte characters.
SHIPTOZIP U.S. ZIP code or other country-specific postal code. This field is required if
a U.S. shipping address is used and may be required for other countries.
Character length and limitations: 20 single-byte characters.
SHIPTOCOUNTRYCODE Country code. This field is required if the shipping address is used.
Character limit: 2 single-byte characters.
SHIPTOPHONENUM (Optional) Phone number.
Character length and limit: 20 single-byte characters.
Field Description
BILLINGPERIOD (Required) Unit for billing during this subscription period.
One of the following values:
z Day
z Week
z SemiMonth
z Month
z 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 (Required) 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.