HTML Variables for PayPal Payments Standard

For shopping cart purchases. The following variables specify the kind of shopping cart button that the person clicked:

• add. Add to Cart buttons for the PayPal Shopping Cart
• display. View Cart buttons for the PayPal Shopping Cart
• upload. The Cart Upload command for third-party carts

Required for buttons that have been saved in PayPal accounts.

Otherwise, not allowed.

The ID of the button that was saved in a merchant's PayPal account. PayPal assigns the value when payment buttons are first created and saved in merchants' PayPal accounts.

An identifier of the source that built the code for the button that the buyer clicked, sometimes known as the build notation. Specify a value using the following format:

Company_Service_Product_Country

Substitute <Service> with an appropriate value:

• BuyNow
  Important: The BuyNow is deprecated. For new integrations, see Customize the PayPal Checkout Button.
• AddToCart
• Donate
• Subscribe
• AutomaticBilling
• ShoppingCart

Substitute <Product> with WPS always for PayPal Payments Standard payment buttons and for the PayPal Payments Standard Cart Upload command.

Substitute <Country> with an appropriate two-letter country code from codes defined by the ISO 3166-1 standard.

For example, a Buy Now button on your website that you coded yourself might have the following line of code:

The price or amount of the product, service, or contribution, not including shipping, handling, or tax. If you omit this variable from Buy Now or Donate buttons, buyers enter their own amount at the time of payment.

• Required for Add to Cart buttons
• Optional for Buy Now and Donate buttons

• Not used with Subscribe buttons.

Discount amount associated with an item, which must be less than the selling price of the item. If you specify discount_amount and discount_amount2 is not defined, this flat amount is applied regardless of the quantity of items purchased.

Valid only for Buy Now and Add to Cart buttons.

Discount amount associated with each additional quantity of the item, which must be equal to or less than the selling price of the item. For discount_amount2 to take effect, you must also specify a discount_amountthat is greater than or equal to 0.

Valid only for Buy Now and Add to Cart buttons.

Discount rate, as a percentage, associated with an item.

Set to a value less than 100. If you do not set discount_rate2, the value in discount_rate applies only to the first item regardless of the quantity of items purchased.

Valid only for Buy Now and Add to Cart buttons.

Discount rate, as a percentage, associated with each additional quantity of the item.

Must be equal to or less than 100. For discount_rate2 to take effect, you must also specify a discount_rate that is greater than or equal to 0.

Valid only for Buy Now and Add to Cart buttons.

Number of additional quantities of the item to which the discount applies.

Applicable when you specify discount_amount2 or discount_rate2. Specifies an upper limit on the number of discounted items.

Valid only for Buy Now and Add to Cart buttons.

Description of item. If you omit this variable, buyers enter their own name during checkout.

• Optional for Buy Now, Donate, Subscribe, Automatic Billing, and Add to Cart buttons

Number of items. If profile-based shipping rates are configured with a basis of quantity, the sum of quantity values is used to calculate the shipping charges for the payment. PayPal appends a sequence number to uniquely identify the item in the PayPal Shopping Cart. For example, quantity1, quantity2, and so on.

The cost of shipping this item. If you specify shipping and shipping2 is not defined, this flat amount is charged regardless of the quantity of items purchased.

This shipping variable is valid only for Buy Now and Add to Cart buttons.

By default, if profile-based shipping rates are configured, buyers are charged an amount according to the shipping methods they choose.

The cost of shipping each additional unit of this item. If you omit this variable and profile-based shipping rates are configured, buyers are charged an amount according to the shipping methods they choose.

This shipping variable is valid only for Buy Now and Add to Cart buttons.

Transaction-based tax override variable. Set this variable to a percentage that applies to the amount multiplied by the quantity selected during checkout. This value overrides any tax settings set in your account profile. A valid value is from 0.001 to 100. Valid only for Buy Now and Add to Cart buttons. By default, profile tax settings, if any, apply.

Enables buyers to specify the quantity. For example, 1.

• Optional for Buy Now buttons.
• Not used with other buttons.

Weight of items. If profile-based shipping rates are configured with a basis of weight, the sum of weight values is used to calculate the shipping charges for the payment.

A valid value is a decimal number with two significant digits to the right of the decimal point.

The unit of measure if weight is specified. Valid value is lbs or kgs.

Default is lbs.

First option field name and label. The os0 variable contains the corresponding value for this option field. For example, if on0 is size, os0 could be large.

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.
• Not used with Donate buttons.

Second option field name and label. The os1 variable contains the corresponding value for this option field. For example, if on1 is color then os1 could be blue.

You can specify a maximum of 7 option field names (6 with Subscribe buttons) by incrementing the option name index (on0 through on6).

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.
• Not used with Donate buttons.

Option selection of the buyer for the first option field, on0. If the option field is a dropdown menu or a set of radio buttons, each valid value is no more than 64 characters. If buyers enter this value in a text field, the maximum value is 200 characters long.

For priced options, include the price and currency symbol in the text of the option selections:

1<option value="small">small - $10.00</option>

Add a corresponding option_select0 and option_amount0 variable for each priced option. Priced options are supported only for Buy Now and Add to Cart buttons. Only one dropdown menu option selection can have priced options.

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.

• Not used with Donate buttons.

Option selection of the buyer for the second option field, on1. If the option field is a dropdown menu or a set of radio buttons, each valid value is no more than 64 characters. If buyers enter this value in a text field, the maximum value is 200 characters long.

You can specify a maximum of seven option selections (6 with Subscribe buttons) by incrementing the option selection index (os0 through os6). You can implement up to five option selections as dropdown menus and up to two option selections as test boxes.

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.

• Not used with Donate buttons.

The cardinal number of the option field, on0 through on9, that has product options with different prices for each option. Include option_index if the option field with prices is not on0.

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing, buttons.
• Not used with Donate buttons.

Default is 0.

For priced options, the value of the first option selection of the on0 dropdown menu. The values must match exactly:

1<option value="">small - $10.00</option> ... <input type="hidden" name="option_select0" value="">

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.
• Not used with Donate buttons.

For priced options, the amount that you want to charge for the first option selection of the on0 dropdown menu. Use only numeric values; the currency is taken from the currency_code variable. For example:

1<option value="small">small - $... <input type="hidden" name="option_amount0"</option> value="10.00">

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.

• Not used with Donate buttons.

For priced options, the value of the second option selection of the on0 dropdown menu. For example:

1... <option value="">small - $10.00</option> ... <input type="hidden" name="option_select" value="">

You can specify a maximum of 10 option selections by incrementing the option selection index (option_select0 through option_select9).

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.
• Not used with Donate buttons.

For priced options, the amount that you want to charge for the second option selection of the on0 dropdown menu. For example:

1...<option value="small">medium - $</option> ... <input type="hidden" name="option_amount1" value="">

You can specify a maximum of 10 option amounts by incrementing the option amount index (option_amount0 through option_amount9).

• Optional for Buy Now, Add to Cart, Subscribe, and Automatic Billing buttons.

• Not used with Donate buttons.

1. The address specified with automatic fill-in variables overrides the PayPal member's stored address. Buyers see the addresses that you pass in, but they cannot edit them. PayPal does not show addresses if they are invalid or omitted.

For more information, see the Auto-fill PayPal checkout page variables.

The currency of the payment. Default is USD.

For valid values, see Currencies Supported by PayPal.

Pass-through variable for your own tracking purposes, which buyers do not see.

By default, no variable is passed back to you.

Handling charges. This variable is not quantity-specific. The same handling cost applies, regardless of the number of items on the order.

By default, no handling charges are included.

Pass-through variable you can use to identify your invoice number for this purchase.

By default, no variable is passed back to you.

If profile-based shipping rates are configured with a basis of weight, PayPal uses this value to calculate the shipping charges for the payment. This value overrides the weight values of individual items.

A valid value is a decimal number with two significant digits to the right of the decimal point.

The unit of measure if weight_cart is specified. Valid value is lbs or kgs.

Default is lbs.

Add an item to the PayPal Shopping Cart.

Set this variable, as follows:

add="1"

Alternatively, use the display="1" variable, which displays the contents of the PayPal Shopping Cart to the buyer.

If you specify both add and display, display takes precedence.

The amount associated with item x. To pass an aggregate amount for the entire cart, use amount_1.

Applies only to the Cart Upload command.

Single discount amount charged cart-wide.

It must be less than the selling price of all items combined in the cart. This variable overrides any individual item discount_amount_x values, if present.

Applies only to the Cart Upload command.

The discount amount associated with item x.

It must be less than the selling price of the associated item. This amount is added to any other item discounts in the cart.

Applies only to the Cart Upload command.

Single Discount rate, as a percentage, to be charged cart-wide.

Set to a value less than 100. The variable overrides any individual item discount_rate_x values, if present.

Applies only to the Cart Upload command.

The discount rate associated with item x.

Set to a value less than 100. The variable takes into account all quantities of item x.

Applies only to the Cart Upload command.

Display the contents of the PayPal Shopping Cart to the buyer. This variable must be set as follows:

display="1"

The alternative is the add="1" variable, which adds an item to the PayPal Shopping Cart.

If both add and display are specified, display takes precedence.

The name associated with item x. To pass an aggregate name for the entire cart, use item_name_1.

Applies only to the Cart Upload command.

Indicates whether the payment is a final sale or an authorization for a final sale, to be captured later.

Valid value is sale, authorization, or order.

Default is sale. To place a hold on the PayPal account for the authorized amount, set this value to authorization. To authorize the payment without placing a hold on the PayPal account, set this value to order.

The URL of the page on the merchant website that buyers go to when they click the Continue Shopping button on the PayPal Shopping Cart page.

For more information see Continue shopping on current the merchant web page.

Upload the contents of a third-party shopping cart or a custom shopping cart.

Set this variable as follows:

upload="1"

Alternatively, use the add="1" variable and the display="1" variables with the PayPal Shopping Cart.

The currency of prices for trial periods and the subscription. Default is USD.

For valid values, see Currencies Supported by PayPal.

Trial period 1 units of duration.

Valid value is:

• D. Days. Valid range for p1 is 1 to 90.
• W. Weeks. Valid range for p1 is 1 to 52.
• M. Months. Valid range for p1 is 1 to 24.
• Y. Years. Valid range for p1 is 1 to 5.

Trial period 2 units of duration.

Valid value is:

• D. Days. Valid range for p2 is 1 to 90.
• W. Weeks. Valid range for p2 is 1 to 52.
• M. Months. Valid range for p2 is 1 to 24.
• Y. Years. Valid range for p2 is 1 to 5.

Regular subscription units of duration.

Valid value is:

• D. Days. Valid range for p3 is 1 to 90.
• W. Weeks. Valid range for p3 is 1 to 52.
• M. Months. Valid range for p3 is 1 to 24.
• Y. Years. Valid range for p3 is 1 to 5.

Recurring payments. Subscription payments recur unless subscribers cancel their subscriptions before the end of the current billing cycle or you limit the number of times that payments recur with the value that you specify for srt.

Valid value is:

• 0. Subscription payments do not recur.
• 1. Subscription payments recur.

Default is 0.

Reattempt on failure. If a recurring payment fails, PayPal attempts to collect the payment two more times before canceling the subscription.

Valid value is:

• 0. Do not reattempt failed recurring payments.
• 1. Reattempt failed recurring payments before canceling.

Default is 1.

For more information, see Reattempting Failed Recurring Payments with Subscribe Buttons.

Do not prompt buyers to include a note with their payments. Valid value is from Subscribe buttons:

• 1. Hide the text box and the prompt.

For Subscribe buttons, always set no_note to 1.

Specify whether to let buyers enter maximum billing limits in a text box or choose from a list of maximum billing limits that you specify.

Valid value is:

• max_limit_own. your button displays a text box for buyers to enter their own maximums above a minimum billing limit that you set with the min_amount variable.
• max_limit_defined. your button displays a dropdown menu of product options with prices to let buyers choose their maximum billing limits.

The URL of the 150x50-pixel image displayed as your logo in the upper left corner of the PayPal checkout pages.

Default is your business name, if you have a PayPal Business account or your email address, if you have PayPal Premier or Personal account.

The locale of the checkout login or sign-up page. PayPal provides localized checkout pages for some countries and languages.

For more information about locale codes and a list of supported locales, see the PayPal locale codes reference page.

Do not prompt buyers for a shipping address.

Valid value is:

• 0. Prompt for an address, but do not require one.
• 1. Do not prompt for an address.
• 2. Prompt for an address and require one.

Default is 0.

The URL to which PayPal redirects buyers' browser after they complete their payments. For example, specify a URL on your site that displays a thank you for your payment page.

By default, PayPal redirects the browser to a PayPal webpage.

Return method. The FORM METHOD used to send data to the URL specified by the return variable.

Valid value is:

• 0. All shopping cart payments use the GET method.
• 1. The buyer's browser is redirected to the return URL by using the GET method, but no payment variables are included.
• 2. The buyer's browser is redirected to the return URL by using the POST method, and all payment variables are included.

Default is 0.

A URL to which PayPal redirects the buyers' browsers if they cancel checkout before completing their payments. For example, specify a URL on your website that displays the Payment Canceled page.

By default, PayPal redirects the browser to a PayPal webpage.

Sets shipping and billing country.

For valid values, see Country and Region Codes.

Sets the language for the billing information/log-in page only. Default is US.

For valid values, see Countries and Regions Supported by PayPal.

Sets the character set and character encoding for the billing information/log-in page on the PayPal website. In addition, this variable sets the same values for information that you send to PayPal in your HTML button code. Default is based on the language encoding settings in your account profile.

For valid values, see Setting the Character Set — charset.

U.S. state.

For valid values, see PayPal state and province codes.

The timeout in seconds for callback responses from your Instant Update callback server. After exceeding the timeout, PayPal uses the fallback values on the Review Your Payment page for tax, shipping, and insurance.

Valid value is from 1 through 6. PayPal recommends the value 3.

Name and label of shipping option x to use as a fallback, if the callback response times out. For example, "Express 2 days". You can include a maximum of 10 shipping options as fallbacks. Substitute x with ordinal numbers, starting with 0.

Include one instance of this variable, with its index (x) set to 0. If you include just one instance, include fallback_shipping_option_is_default_x parameter with its index, x, set to 0 and its value set to 1.

A valid value for x is from 0 to 9.

Shipping amount for option x to use as a fallback, if the response times out.

Valid value for x is from 0 to 9.

Indicates that shipping option x is the default and should be selected in the dropdown menu as a fallback, if the response times out.

Only one shipping option can be the default for buyers. Check that you set one instance only of fallback_shipping_option_is_default_x to 1.

Valid value is:

• 1. Shipping option x is the default shipping option.
• 0. Shipping option x is not the default shipping option.

Valid value for x is from 0 to 9.

Indicates that insurance is offered and consumers can opt in to the insurance during checkout. PayPal ignores this variable if you omit fallback_insurance_amount or its value is less than or equal to 0.

Valid value is:

• 1. Insurance is offered and consumers can opt in to during checkout.
• 0. Insurance is applied along with the transaction, if applicable. The consumer will NOT have a choice to remove the insurance from the transaction amount.

Height of item x in the shopping cart.

A valid value is a positive integer.

Unit of measure for the values specified by the height_x values.

A valid value is any value that you choose. PayPal passes the value to your callback server in callback requests.

Width of item x in the shopping cart.

A valid value is a positive integer.

Unit of measure for the value specified by width_x.

A valid value is any value that you choose. PayPal passes the value to your callback server in callback requests.

Length of item x in the shopping cart.

Valid value is a positive integer.

Unit of measure for the value specified by length_x.

Valid value is any value that you choose. PayPal passes the value to your callback server in callback requests.

Sets the text for the Return to Merchant button on the PayPal Payment Complete page. For Business accounts, the return button displays your business name in place of Merchant, by default. By default, the text readsReturn to donations coordinator for Donate buttons.

The HTML hex code for your principal identifying color. PayPal blends your color to white in a gradient fill that borders the cart review area of the PayPal checkout user interface.

Valid value is 6 single-byte hexadecimal characters that represent an HTML hex code for a color.

• Valid only for Buy Now and Add to Cart buttons and the Cart Upload command.

• Not used with Subscribe or Donate buttons.

The image at the top left of the checkout page. The image's maximum size is 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored only on a secure (https) server.

For more information, see Customize PayPal Checkout Pages in the Merchant Setup and Administration Guide.

Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command.

The background color for the header of the checkout page.

Valid value is case-insensitive six-character, HTML hexadecimal color code in ASCII.

Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command.

The border color around the header of the checkout page. The border is a 2-pixel perimeter around the header space, which has a maximum size of 750 pixels wide by 90 pixels high.

Valid value is case-insensitive six-character, HTML hexadecimal color code in ASCII.

Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command.

A URL to your logo image. Use a valid graphics format, such as .gif, .jpg, or .png. Limit the image to 190 pixels wide by 60 pixels high. PayPal crops images that are larger. PayPal places your logo image at the top of the cart review area.

Valid value is 127 single-byte alphanumeric characters.

• Valid only for Buy Now and Add to Cart buttons and the Cart Upload command.

• Not used with Subscribe or Donate buttons.

The background color for the checkout page below the header. Valid value is case-insensitive six-character, HTML hexadecimal color code in ASCII.

Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command.

Modification behavior.

Valid value is:

• 0. Default. Enables subscribers only to sign up for new subscriptions.
• 1. Enables subscribers to sign up for new subscriptions and modify their current subscriptions.
• 2. Enables subscribers to modify only their current subscriptions.

Deprecation behavior: The modify values 1 and 2 are deprecated. If your customer clicks an existing modify subscription button that uses a modify value of 1 or 2, PayPal returns the following message: Things don't appear to be working at the moment. Please try again later. Update your code to use modify=0, the only valid value, which allows your customers to sign up for new subscriptions only.

Do not prompt buyers to include a note with their payments.

Valid value is:

• 0. Provide a text box and prompt for the note.
• 1. Hide the text box and the prompt.

Default is 0. To add a text label for the text box, such as, Enter any special instructions:, use the cn variable.

The custom payment page style for checkout pages.

Valid value is:

• paypal. use the PayPal page style
• primary. use the page style that you marked as primary in your account profile
• page_style_name. use the custom payment page style from your account profile that has the specified name

Default is primary if you added a custom payment page style to your account profile. Otherwise, Default is paypal.

The button that the person clicked was a Buy Gift Certificate button.

Set to 1 to have PayPal generate usernames and initial passwords for subscribers.

For more information, see Generate Subscriber User Names and Passwords.