Affiliates' Instant Notification Variables

 
Variable Type Description
testMode Y/N Test transaction made by the Vendor
referenceNumber Number Plimus Reference Number
originalReferenceNumber Number Plimus Original Reference Number (for subscriptions)
subscriptionId Number The permanent numeric identifier set by Plimus for promotion on a subscription or recurring charge order.
transactionDate mm/dd/yyyy hh:mi AM/PM Date & Time transaction occurred
untilDate mm/dd/yyyy hh:mi AM/PM Subscription expiration date
transactionType String
  • AUTH_ONLY - orders that were authorized for a future charge
  • CHARGE - orders that were successfully charged
  • REFUND - orders that were refunded
  • CHARGEBACK - ordered that were charged back by the customer
  • CANCELLATION - orders that were cancelled (for unapproved orders and cancelled subscriptions)
  • RECURRING - subscription orders that were successfully charged
  • CANCELLATION_REFUND - orders that were refunded and cancelled (for cancelled subscriptions)
  • CONTRACT_CHANGE - subscription orders that had their contract switched
productId Number Plimus Product Id
productName String Product name
contractId Number Plimus Contract Id
contractName String Contract name
contractOwner String Contract owner
contractPrice Number #,###.## Contract price
quantity Number Quantity ordered
currency String Currency code used in the order
addCD Y/N Did the Customer also order a CD on Demand ?
coupon String Did the Customer use a coupon
couponValue Number #,###.## coupon value
referrer String The referrer URL that the Customer came from to the BuyNow page
promoteContractId# Number Promotion Contract ID. The # sign from 0 to number of the promotion contracts in the order
promoteContractName# String Promotion contract name. The # sign from 0 to number of the promotion contracts in the order
promoteProductId# Number Promotion Product ID. The # sign from 0 to number of the promotion contracts in the order
promoteProductName# String Promotion Product name. The # sign from 0 to number of the promotion contracts in the order
promoteContractOwner# String Promotion contract owner. The # sign from 0 to number of the promotion contracts in the order
promoteContractPrice# Number #,###.## Promotion contract price. The # sign from 0 to number of the promotion contracts in the order
promoteContractQuantity# Number Promotion contract quantity. The # sign from 0 to number of the promotion contracts in the order
promoteSubscriptionId# Number Promotion subscription Id. The # sign from 0 to number of the promotion contracts in the order
promoteContractsNum Number Number of promotions.
invoiceAmount (Deprecated) Number #,###.## The invoice amount in USD
invoiceAmountUSD Number #,###.## The invoice amount in USD
invoiceChargeCurrency Number #,###.## The currency the shopper was billed in
invoiceChargeAmount Number #,###.## The invoice amount in shopper's local currency
paymentMethod String Method of payment, i.e. CC/PAYPAL/WIRE
creditCardType String Type of credit-card, i.e. AMEX/VISA
shippingMethod String i.e. UPS/USPS
remoteAddress String Customer remote IP address
invoiceInfoURL String Invoice details web-page