Subscriptions and Recurring Payments Variables

Below are additional variables that are used for Instant Payment Notifications for Subscriptions and Recurring Payments. For more information, see the Subscriptions and Recurring Payments Manual (PDF 636K / 52 pages) and the PayPal Payments Standard Integration Guide

Variable	Value	Description
txn_type	"subscr_signup"	This Instant Payment Notification is for a subscription sign-up.
	"subscr_cancel"	This Instant Payment Notification is for a subscription cancellation.
	"subscr_modify"	This Instant Payment Notification is for a subscription modification.
	"subscr_failed"	This Instant Payment Notification is for a subscription payment failure.
	"subscr_payment"	This Instant Payment Notification is for a subscription payment.
	"subscr_eot"	This Instant Payment Notification is for a subscription's end of term.
subscr_date	Transaction-specific	Start date or cancellation date depending on whether transaction is "subscr_signup" or "subscr_cancel"
subscr_effective	Transaction-specific	Date when the subscription modification will be effective (only for txn_type = subscr_modify)
period1	Transaction-specific	(optional) Trial subscription interval in days, weeks, months, years (example: a four-day interval is "period1: 4 D")
period2	Transaction-specific	(optional) Trial subscription interval in days, weeks, months, years
period3	Transaction-specific	Regular subscription interval in days, weeks, months, years
amount1	Transaction-specific	Amount of payment for trial period one for USD payments; otherwise blank (optional)
amount2	Transaction-specific	Amount of payment for trial period two for USD payments; otherwise blank (optional)
amount3	Transaction-specific	Amount of payment for regular subscription period for USD payments; otherwise blank
mc_amount1	Transaction-specific	Amount of payment for trial period one, regardless of currency (optional)
mc_amount2	Transaction-specific	Amount of payment for trial period two, regardless of currency (optional)
mc_amount3	Transaction-specific	Amount of payment for regular subscription period, regardless of currency
mc_currency	"USD"	The currency of the payment is US Dollars (non-payment Instant Payment Notifications only).
	"GBP"	The currency of the subscription is Pounds Sterling (non-payment Instant Payment Notifications only).
	"EUR"	The currency of the subscription is Euros (non-payment Instant Payment Notifications only).
	"CAD"	The currency of the subscription is Canadian Dollars (non-payment Instant Payment Notifications only).
	"JPY"	The currency of the payment is Japanese Yen (non-payment Instant Payment Notifications only).
recurring	Transaction-specific	Indicates whether regular rate recurs (1 is yes, left blank is no).
reattempt	Transaction-specific	Indicates whether reattempts should occur upon payment failures (1 is yes, left blank is no).
retry_at	Transaction-specific	Date we will retry failed subscription payment.
recur_times	Transaction-specific	How many payment installments will occur at the regular rate.
username	Transaction-specific	(optional) Username generated by PayPal and given to subscriber to access the subscription.
password	Transaction-specific	(optional) Password generated by PayPal and given to subscriber to access the subscription (password will be hashed).
subscr_id	Transaction-specific	ID generated by PayPal for the subscriber

The table below may help you better understand which Instant Payment Notification variables are associated with each transaction type.

	Subscription Transaction Type
Variable	Signup	Cancel	Modify	Payment (USD)	Payment (MC)	Failed	EOT
Basic Information
business	X	X	X	X	X	X	X
receiver_email	X	X	X	X	X	X	X
receiver_id				X	X	X	X
item_name	X	X	X	X	X	X	X
item_number	X	X	X	X	X	X	X
Advanced and Custom Information
invoice	X	X	X	X	X	X	X
custom	X	X	X	X	X	X	X
option_name1	X	X	X	X	X	X	X
option_selection1	X	X	X	X	X	X	X
option_name2	X	X	X	X	X	X	X
option_selection2	X	X	X	X	X	X	X
Transaction Information
payment_status				X	X
pending_reason				X	X
reason_code				X	X
payment_date				X	X
txn_id				X	X
parent_txn_id				X	X
txn_type	subscr_ signup	subscr_ cancel	subscr_ modify	subscr_payment
Currency and Exchange Information
mc_gross				X	X
mc_fee				X	X
mc_currency	X	X	X	X	X	X	X
settle_amount				X	X
settle_currency				X	X
exchange_rate				X	X
payment_gross				X		X	X
payment_fee				X
Buyer Information
first_name	X	X	X	X	X	X	X
last_name	X	X	X	X	X	X	X
payer_business_name				X	X
address_name	X	X	X	X	X
address_street	X	X	X	X	X
address_city	X	X	X	X	X
address_state	X	X	X	X	X
address_zip	X	X	X	X	X
address_country	X	X	X	X	X
address_status	X	X	X	X	X
payer_email	X	X	X	X	X	X	X
payer_id	X	X	X	X	X	X	X
payer_status	X	X	X	X	X	X	X
payment_type				X	X
IPN Information
notify_version	X	X	X	X	X	X	X
Security Information
verify_sign	X	X	X	X	X	X	X
Subscription Information
subscr_date	X	X	X
subscr_effective			X
period1	X	X	X
period2	X	X	X
period3	X	X	X
amount1	X	X	X
amount2	X	X	X
amount3	X	X	X
mc_amount1	X	X	X
mc_amount2	X	X	X
mc_amount3	X	X	X
recurring	X	X	X
reattempt	X	X	X
retry_at						X
recur_times	X	X	X
username	X	X	X	X	X	X	X
password	X	X	X	X	X	X	X
subscr_id	X	X	X	X	X	X	X

Back to 'Instant Payment Notification page'