PayPal Subscriptions HTML Code for Recurring Payment
PayPal Subscriptions HTML Code
The following tables show the different parameters within the Subscriptions HTML code and the Subscriptions hyperlink.
src="http://images.paypal.com/images/x-click-but01.gif"
border="0" name="submit"
alt="Make payments with PayPal - it’s fast, free and secure!">
border="0" name="submit"
alt="Make payments with PayPal - it’s fast, free and secure!">
https://www.paypal.com/subscriptions/business=nora%40paypal.com&item_name=Baseball+Hat+Monthly&item_number=123&image_url=https%3A//www.yoursite.com/logo.gif&no_shipping=1&return=http%3A//www.yoursite.com/thankyou.htm&cancel_return=http%3A//www.yoursite.com/cancel.htm&no_note=1&a1=0.00&p1=1&t1=W&a2=5.00&p2=2&t2=M&a3=50.00&p3=1&t3=Y&src=1&sra=1& srt=5&no_note=1&custom=customcode&invoice=invoicenumber&usr_manage=1
Table 9.1
|
Variable Name
Required orOptional
cmd
business
This is your PayPal ID, or email address. This email address must be confirmed and linked to your Verified Business or Premier account
item_name
Description of item being sold (maximum 127 characters). If you are collecting aggregate payments, this can include a summary of all items purchased, tracking numbers, or generic terms such as “subscription.” If omitted, customer will see a field in which they have the option of entering an Item Name
return
An internet URL where the user will be returned after completing the payment. For example, a URL on your site that hosts a “Information on your new subscription” page. If omitted, users will be taken to the PayPal site
rm
Return URL behavior. If set to “1” and if a “return” value is submitted, upon completion of the payment the buyer will be sent back to the return URL using a GET method, and no transaction variables will be submitted. If set to “2” and if a “return” value is submitted, the buyer will be sent back to the return URL using a POST method, to which all available transaction variables will also be posted. If omitted or set to “0”, GET methods will be used for all Subscriptions transactions and Buy Now, Donations, or PayPal Shopping Cart transactions in which IPN is not enabled. POST methods with variables will be used for the rest
cancel_return
An internet URL where the user will be returned if payment is cancelled. For example, a URL on your site which hosts a “Payment Cancelled” page. If if omitted, users will be taken to the PayPal site
a1
Trial amount 1. This is the price of the first trial period. For a free trial, use a value of 0
p1
Trial period 1. This is the length of the first trial period. The number is modified by the trial period 1 units (t1, below)
t1
Trial period 1 units. This is the units of trial period 1 (p1, above). Acceptable values are: D (days), W (weeks), M (months), Y (years)
a2
p2
Trial period 2. This is the length of the second trial period. The number is modified by the trial period 1 units (t2, below)
t2
Trial period 2 units. This is the units of trial period 2 (p2, above). Acceptable values are: D (days), W (weeks), M (months), Y (years)
a3
p3
Regular billing cycle. This is the length of the billing cycle. The number is modified by the regular billing cycle units (t3, below)
t3
[required] Regular billing cycle units. This is the units of the regular billing cycle (p3, above) Acceptable values are: D (days), W (weeks), M (months), Y (years)
src
Recurring payments. If set to “1,” the payment will recur unless your customer cancels the subscription before the end of the billing cycle. If omitted, the subscription payment will not recur at the end of the billing cycle
sra
Reattempt on failure. If set to “1,” and the payment fails, the payment will be reattempted two more times. After the third failure, the subscription will be cancelled. If omitted and the payment fails, payment will not be reattempted and the subscription will be immediately cancelled
srt
Recurring Times. This is the number of payments which will occur at the regular rate. If omitted, payment will continue to recur at the regular rate until the subscription is cancelled
no_note
This field makes sure your subscriber is not prompted to include a note with the subscription, a function which PayPal Subscriptions does not support. This field must be included, and the value must be set to 1
custom
User-defined field (maximum 255 characters) which will be passed through the system and returned to user in payment notification emails. This field will not be shown to your subscribers
invoice
User- defined field (maximum 127 characters) which must be unique with each subscription. The invoice number will be shown to subscribers with the other details of their transactions
usr_manage
Username and password generation field. If set to “1” PayPal will generate usernames and passwords for your subscribers. For use with Password Management (see page 33). If omitted, no passwords will be generated
cn
Label that will appear above the note field (maximum 30characters). This value is not saved and will not appear in any of your notifications. If omitted, no variable will be passed back to you. “Special instructions (optional):” will be displayed.
cs
Sets the background color of your payment pages. If set to “1,” the background color will be black. If omitted or set to “0” the background color will be white
on0
First option field name (maximum 30 characters). If omitted, no variable will be passed back to you
os0
First set of option value(s). If this option is selected through a text box (or radio button), each value should be no more than 30 characters. If this value is entered by the customer through a text box, there is a 200-character limit. If omitted, no variable will be passed back to you. “on0” must be defined in order for “os1” to be recognized
on1
Second option field name (maximum 30 characters). If omitted, no variable will be passed back to you
os1
Second set of option value(s). If this option is selected through a text box (or radio button), each value should be no more than 30 characters. If this value is entered by the customer through a text box, there is a 200-character limit. If omitted, no variable will be passed back to you. “on1” must be defined in order for “os1” to be recognized
tax
Transaction-based tax override variable. Set to a flat tax amount you would like to apply to the transaction regardless of the buyer’s location. If present, this value overrides any tax settings that may be set in the seller’s Profile. If omitted, Profile tax settings (if any) will apply
currency_code
The currency of the payment. Defines the currency in which the monetary variables (amount, shipping, shipping2, handling, tax) are denoted.
modify
0 or null = The button allows buyers to only create newsubscriptions.
1 = The button allows buyers to modify current subscriptions if they have any and to sign up for new subscriptions if they do not.
2 = The button allows buyers only to modify existingsubscriptions according to the other parameters specified by the button and does not allow sign-up for new subscriptions.
lc
Sets the default country and associated language for the login or signup page that your customers see when they click your button. If this variable is absent, the default will be set from the user’s cookie, or will be set to the U.S. if there is no cookie. Can be set to any of the countries currently available on PayPal.
page_style
Sets the Custom Payment Page Style for payment pages associated with this button/link. The value of page_style is the same as the Page Style Name you chose when adding or editing the page style. You can add and edit Custom Payment Page Styles from the Profile section of the My Account tab. If you would like the button/link to always reference the style you make Primary, set this variable equal to "primary." If you would like the button/link to reference the default PayPal page style, set this variable equal to "paypal." The page_style variable has a maximum length of 30 characters. Valid character set is alphanumeric ASCII lower 7-bit characters only, plus underscore. It cannot include spaces
Note:
|
If you would like to remove the values for a variable (i.e. leave the amount blank for your customer to define), you should remove the entire variable, not just the value. For example, you should remove this entire line from the code:
<input type="hidden" name="amount" value="$5.95"> rather than just the value of "5.95". |
Comments
Post a Comment