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 Website Payments Standard Integration Guide

VariableValueDescription
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_dateTransaction-specificStart date or cancellation date depending on whether transaction is "subscr_signup" or "subscr_cancel"
subscr_effectiveTransaction-specificDate when the subscription modification will be effective (only for txn_type = subscr_modify)
period1Transaction-specific(optional) Trial subscription interval in days, weeks, months, years (example: a four-day interval is "period1: 4 D")
period2Transaction-specific(optional) Trial subscription interval in days, weeks, months, years
period3Transaction-specificRegular subscription interval in days, weeks, months, years
amount1Transaction-specificAmount of payment for trial period one for USD payments; otherwise blank (optional)
amount2Transaction-specificAmount of payment for trial period two for USD payments; otherwise blank (optional)
amount3Transaction-specificAmount of payment for regular subscription period for USD payments; otherwise blank
mc_amount1Transaction-specificAmount of payment for trial period one, regardless of currency (optional)
mc_amount2Transaction-specificAmount of payment for trial period two, regardless of currency (optional)
mc_amount3Transaction-specificAmount 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).
recurringTransaction-specificIndicates whether regular rate recurs (1 is yes, left blank is no).
reattemptTransaction-specificIndicates whether reattempts should occur upon payment failures (1 is yes, left blank is no).
retry_atTransaction-specificDate we will retry failed subscription payment.
recur_timesTransaction-specificHow many payment installments will occur at the regular rate.
usernameTransaction-specific(optional) Username generated by PayPal and given to subscriber to access the subscription.
passwordTransaction-specific(optional) Password generated by PayPal and given to subscriber to access the subscription (password will be hashed).
subscr_idTransaction-specificID 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
VariableSignupCancelModifyPayment
(USD)
Payment
(MC)
FailedEOT
Basic Information
businessXXXXXXX
receiver_emailXXXXXXX
receiver_id   XXXX
item_nameXXXXXXX
item_numberXXXXXXX
Advanced and Custom Information
invoiceXXXXXXX
customXXXXXXX
option_name1XXXXXXX
option_selection1XXXXXXX
option_name2XXXXXXX
option_selection2XXXXXXX
Transaction Information
payment_status   XX  
pending_reason   XX  
reason_code   XX  
payment_date   XX  
txn_id   XX  
parent_txn_id   XX  
txn_typesubscr_
signup
subscr_
cancel
subscr_
modify
subscr_payment  
Currency and Exchange Information
mc_gross   XX  
mc_fee   XX  
mc_currencyXXXXXXX
settle_amount   XX  
settle_currency   XX  
exchange_rate   XX  
payment_gross   X XX
payment_fee   X   
Buyer Information
first_nameXXXXXXX
last_nameXXXXXXX
payer_business_name   XX  
address_nameXXXXX  
address_streetXXXXX  
address_cityXXXXX  
address_stateXXXXX  
address_zipXXXXX  
address_countryXXXXX  
address_statusXXXXX  
payer_emailXXXXXXX
payer_idXXXXXXX
payer_statusXXXXXXX
payment_type   XX  
IPN Information
notify_versionXXXXXXX
Security Information
verify_signXXXXXXX
Subscription Information
subscr_dateXXX    
subscr_effective  X    
period1XXX    
period2XXX    
period3XXX    
amount1XXX    
amount2XXX    
amount3XXX    
mc_amount1XXX    
mc_amount2XXX    
mc_amount3XXX    
recurringXXX    
reattemptXXX    
retry_at     X 
recur_timesXXX    
usernameXXXXXXX
passwordXXXXXXX
subscr_idXXXXXXX


Back to 'Instant Payment Notification page'