IPN Subscriptions Variables

 

Subscriptions Variables

Along with other IPN variables, the following variables are included in Subscriptions IPNs.

Table A.1

Subscriptions Variables

Variable	Possible Values	Description	Char Limit
txn_type	subscr-failed subscr- cancel subscr- payment subscr-signup subscr-eot subscr- modify	subscr_signup: subscription sign-up. subscr_cancel: subscription cancellation. subscr_failed: subscription payment failure. subscr_payment: subscription payment. subscr_eot: subscription’s end-of-term. subscr_modify: subscription modification.
subscr_date		Start date or cancellation date depending on whether transaction is subscr_signupor subscr_cancel. Time/Date stamp generated by PayPal , in the following format: HH:MM:SS DD Mmm YY, YYYY PST
subscr_ effective		Date when the subscription modification will be effective (only for txn_type = subscr_modify). Time/Date stamp generated by PayPal , in the following format: HH:MM:SS DD Mmm YY, YYYY PST
period1		(optional) Trial subscription interval in days, weeks, months, years (example: a 4 day interval is “period1: 4 D”).
period2		(optional) Trial subscription interval in days, weeks, months, or years.
period3		Regular subscription interval in days, weeks, months, or years.
amount1		Amount of payment for trial period 1 for USD payments; otherwise blank (optional).
amount2		Amount of payment for trial period 2 for USD payments; otherwise blank (optional).
amount3		Amount of payment for regular subscription period for USD payments; otherwise blank.
mc_amount1		Amount of payment for trial period 1, regardless of currency (optional).
mc_amount2		Amount of payment for trial period 2, regardless of currency (optional).
mc_amount3		Amount of payment for regular subscription period, regardless of currency.
mc_currency	See table of supported currencies.	For non-payment subscriptions IPNs (i.e., txn_type= signup, cancel, failed, eot, or modify), this is the currency of the subscription. For payment IPNs, it is the currency of the payment (i.e., txn_type = subscr_payment)
recurring		Indicates whether regular rate recurs (1 is yes, blank is no).
reattempt		Indicates whether reattempts should occur upon payment failures (1 is yes, blank is no).
retry_at		Date PayPal will retry a failed subscription payment.
recur_times		The number of payment installments that will occur at the regular rate.
username		(optional) Username generated by PayPal and given to subscriber to access the subscription.	64
password		(optional) Password generated by PayPal and given to subscriber to access the subscription (password will be encrypted).	24
subscr_id		ID generated by PayPal for the subscriber.	19

Variables for Each Subscription Event

The following table shows which variables are associated and can be included in IPN posts with each subscription event type.

About payment_status and txn_type with Subscription IPN

In IPN messages posted by Subscription events, the payment_status variable is sent when a payment or refund occurs. For all other events, the pertinent variable is txn_type.

Table A.2

IPN Variables with Each Subscription Event

Variable	Signup	Cancel	Modify	Payment (USD)	Payment (Multi-Currency)	Refund	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
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	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			subscr_ failed	subscr_ eot
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
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	X	X	X		X
address_name	X	X	X	X	X		X
address_street	X	X	X	X	X		X
address_city	X	X	X	X	X		X
address_state	X	X	X	X	X		X
address_zip	X	X	X	X	X		X
address_ country	X	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
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
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