| METHOD: |
|
|
|
| VERSION: |
|
|
|
Main Request Fields: |
| PROFILEID: |
(Required!) |
|
|
|
Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.
Character length and limitations: 14 single-byte alphanumeric characters. 19 character profile IDs are supported for compatability with previous versions of the PayPal API.
|
| NOTE: |
|
|
|
|
The reason for the update to the recurring payments profile. This message will be included in the email notification to the buyer for the recurring payments profile update. This note can also be seen by both you and the buyer on the Status History page of the PayPal account.
|
| DESC: |
|
|
|
|
Description of the recurring payment.
Character length and limitations: 127 single-byte alphanumeric characters.
|
| SUBSCRIBERNAME: |
|
|
|
|
Full name of the person receiving the product or service paid for by the recurring payment. If not present, the name in the buyer’s PayPal account is used. Character length and limitations: 32 single-byte characters.
|
| PROFILEREFERENCE: |
|
|
|
|
The merchant’s own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters.
|
| ADDITIONALBILLINGCYCLES: |
|
|
|
|
The number of additional billing cycles to add to this profile.
|
| AMT: |
(Required!) |
|
|
|
Billing amount for each cycle in the subscription period, not including shipping and tax amounts. Note: For recurring payments with Express Checkout, the payment amount can be increased by no more than 20% every 180 days (starting when the profile is created). Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
|
| SHIPPINGAMT: |
|
|
|
|
Shipping amount for each billing cycle during the regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
|
| TAXAMT: |
|
|
|
|
Tax amount for each billing cycle during the regular payment period. Note: All amounts in the request must have the same currency. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
|
| OUTSTANDINGAMT: |
|
|
|
|
The current past due or outstanding amount for this profile. You can only decrease the outstanding amount—it cannot be increased. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
|
| AUTOBILLOUTAMT: |
|
|
|
|
This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. Valid values: Must be NoAutoBill or AddToNextBilling.
|
| MAXFAILEDPAYMENTS: |
|
|
|
|
The number of failed payments allowed before the profile is automatically suspended. The specified value cannot be less than the current number of failed payments for this profile. Character length and limitations: Number string representing an integer.
|
| PROFILESTARTDATE: |
|
|
|
|
The date when billing for this profile begins. Must be a valid date, in UTC/GMT format. Note: The profile may take up to 24 hours for activation.
|
Ship To Address Fields: |
| 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: |
|
|
|
|
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: |
|
|
|
|
Phone number. Character length and limit: 20 single-byte characters.
|
Billing Period Details Type: |
| BILLINGPERIOD: |
(Required!) |
|
|
|
Unit for billing during this subscription period. 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: |
(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.
|
| TOTALBILLINGCYCLES: |
|
|
|
|
The number of billing cycles for 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 TotalBillingCycles cycles.
|
| TRIALBILLINGPERIOD: |
|
|
|
|
Unit for billing during this subscription period; required if you specify an optional trial period. 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.
|
| TRIALBILLINGFREQUENCY: |
|
|
|
|
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.
|
| TRIALTOTALBILLINGCYCLES: |
|
|
|
|
The number of billing cycles for trial payment period.
|
| TRIALAMT: |
|
|
|
|
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: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD.
|
| CURRENCYCODE: |
(Required!) |
|
|
|
A three-character currency code. Default: USD
|
Credit Card Details Fields: |
| CREDITCARDTYPE: |
(Required!) |
|
|
|
Type of credit card. Character length and limitations: Up to ten single-byte alphabetic characters. Allowable values: Visa, MasterCard, Discover, Amex, Maestro: See note. Solo: See note. For Canada, only MasterCard and Visa are allowable; Interac debit cards are not supported. Note: If the credit card type is Maestro or Solo, the CURRENCYCODE must be GBP. In addition, either STARTDATE or ISSUENUMBER must be specified.
|
| ACCT: |
(Required!) |
|
|
|
Credit card number. Character length and limitations: numeric characters only. No spaces or punctutation. Must conform with modulo and length required by each credit card type.
|
| EXPDATE: |
(Required!) |
|
|
|
Credit card expiration date. This field is required if you are using recurring payments with direct payments. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters, including leading zero.
|
| CVV2: |
(Required!) |
|
|
|
Card Verification Value, version 2. Your Merchant Account settings determine whether this field is required. Character length for Visa, MasterCard, and Discover: exactly three digits.Character length for American Express: exactly four digits.To comply with credit card processing regulations, you must not store this value after a transaction has been completed.
|
| STARTDATE: |
|
|
|
|
Month and year that Maestro or Solo card was issued, the MMYYYY format. Character length: Must be six digits, including leading zero.
|
| ISSUENUMBER: |
|
|
|
|
Issue number of Maestro or Solo card. Character length: two numeric digits maximum.
|
Payer Info Type Fields: |
| EMAIL: |
|
|
|
|
Email address of payer. Character length and limitations: 127 single-byte characters.
|
| FIRSTNAME: |
(Required!) |
|
|
|
Payer’s first name. Character length and limitations: 25 single-byte characters.
|
| LASTNAME: |
(Required!) |
|
|
|
Payer’s last name. Character length and limitations: 25 single-byte characters.
|
Address Fields: |
| STREET: |
(Required!) |
|
|
|
First street address. Character length and limitations: 100 single-byte characters.
|
| STREET2: |
|
|
|
|
Second street address. Character length and limitations: 100 single-byte characters.
|
| CITY: |
(Required!) |
|
|
|
Name of city. Character length and limitations: 40 single-byte characters.
|
| STATE: |
(Required!) |
|
|
|
State or province. Character length and limitations: 40 single-byte characters.
|
| COUNTRYCODE: |
(Required!) |
|
|
|
(Required) Country code. Character limit: Two single-byte characters.
|
| ZIP: |
(Required!) |
|
|
|
U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters.
|
| PHONENUM: |
|
|
|
|
Phone number.Character length and limit: 20 single-byte characters.
|
|
wait........ |
|
|
|