Notification Reference

Base Notification Content

These fields are present in all notification payloads, regardless of type.

Name	Description	R / O
subject	Event entity type (order, subscription, endUser, etc.)	R
type	Notification event type (e.g. completed, deleted)	R
objectId	Entity identifier (orderId, subscriptionId, endUserId, etc.)	R
eventDate	ISO 8601 date of the event	R

Notifications list

Name	Payload	Subject	Type
Cart Abandoned	ABANDONED_CART	cart	abandoned
Cart created	CART	cart	created
Consent Created	CONSENT_CREATED	consent	created
Consent Updated	CONSENT_UPDATED	consent	updated
EndUser Deleted	END_USER_DELETED	endUser	deleted
Credit Card Added	PAYMENT_METHOD_ADDED	endUser	paymentMethodAddedToWallet
Payment Method Deleted	PAYMENT_METHOD_ADDED	endUser	paymentMethodAddedToWallet
Recurring Payment Method Added	PAYMENT_METHOD_ADDED	endUser	paymentMethodAddedToWallet
SEPA Payment Method Added	PAYMENT_METHOD_ADDED	endUser	paymentMethodAddedToWallet
Subscription Payment Method Updated	PAYMENT_METHOD_UPDATED	endUser	subscriptionPaymentMethodUpdated
Reseller Request Approved	RESELLER	endUser	completed
Reseller Request Declined	RESELLER	endUser	declined
Reseller Request OnBoarding	RESELLER	endUser	onBoardingRequest
Identity created	IDENTITY	identity	created
Identity deleted	IDENTITY	identity	deleted
Identity updated	IDENTITY	identity	updated
Package Threshold Reached	LICENSE_KEY_PACKAGE	licenseKeyPackage	thresholdReached
Offer Prebilling Started	ORDER_AND_SUBSCRIPTION	order	prebillingStarted
Order Canceled With Content Including Subscription Data	ORDER_AND_SUBSCRIPTION	order	canceled
Order Completed With Content Including Subscription Data	ORDER_AND_SUBSCRIPTION	order	completed
Prebilling Order Created	ORDER_AND_SUBSCRIPTION	order	prebillingStarted
Subscription Order Renew Completed	ORDER_AND_SUBSCRIPTION	order	renewCompleted
Subscription Order Renew Completed (offer)	ORDER_AND_SUBSCRIPTION	order	renewCompleted
Offer Order Aborted	ORDER	order	aborted
Offer Order Created	ORDER	order	created
Order Aborted	ORDER	order	aborted
Order Canceled	ORDER	order	canceled
Order Completed	ORDER	order	completed
Order Completed With Error	ORDER	order	partiallyCompleted
Order Created	ORDER	order	created
Order Fulfillment Failed	ORDER	order	fulfillmentFailed
Order Partial Completed	ORDER	order	partialCompleted
Order Payment Failed	ORDER	order	paymentFailed
Order Payment Refused	ORDER	order	paymentRefused
Order payment refused with last error code	ORDER	order	paymentRefusedWithLastErrorCode
Partial refund completed successfully	ORDER	order	partialRefundCompleted
Partial refund completed with errors	ORDER	order	partialRefundFailed
Subscription Discount Plan Updated	DISCOUNT_PLAN_UPDATED	subscription	discountPlanUpdated
Check payment method replayability on updated subscription	SUBSCRIPTION_PAYMENT_METHOD_REPLAYABILITY_CHANGED	subscription	subscriptionPaymentMethodReplayabilityChanged
Subscription Canceled	SUBSCRIPTION	subscription	canceled
Subscription Expiration Date Updated	SUBSCRIPTION	subscription	expirationDateUpdated
Subscription Expired	SUBSCRIPTION	subscription	expired
Subscription Reactivated	SUBSCRIPTION	subscription	reactivated
Subscription Suspended	SUBSCRIPTION	subscription	suspended
Subscription Unpaid	SUBSCRIPTION	subscription	unpaid
Tax Rate Created	TAX_RATE	taxRate	created
Tax Rate Deleted	TAX_RATE	taxRate	deleted
Tax Rate Updated	TAX_RATE	taxRate	updated

Payload schemas

AbandonedCartNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
checkoutUrl	string		O
companyName	string		O
customerId	string		O
firstName	string		O
lastName	string		O
locale	string		O
newsletterOptin	boolean		O
storeHostname	string		O
userEmailAddress	string		O

BaseNotificationContent

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R

ConsentNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
consent	consent.Consent		O
→ consents	consent.ConsentItem[]		O
— → type	string		O
— → lastLegalActionTimestamp	integer (int64)		O
— → lastUpdateReason	string		O
— → status	boolean		O
→ source	string		O
→ updateDate	string (date-time)		O
→ userEmail	string		O

OrderNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
order	order.Order		R
→ cancellationDate	string (date-time)	Cancellation timestamp in ISO 8601 format	O
→ cancellationReason	string	Reason for order cancellation	O
→ cartId	string	Associated cart identifier	O
→ consentFlags	order.ConsentFlags		R
— → newsletterOptin	boolean	Marketing newsletter consent indicator	R
→ creationDate	string (date-time)	Order creation date in ISO 8601 format	R
→ currency	string	Currency code, e.g. EUR, USD	R
→ customer	order.Customer		R
— → customerAccount	string	Realm/account name	R
— → id	string	Customer identifier	R
— → name	string		O
— → serveur	string		O
→ decodedExternalContext	object	Decoded cart parameters	O
→ externalContext	string	Base64 encoded string of cart parameters	O
→ id	string	Order identifier	R
→ items	order.LineItem[]	Order line items	R
— → activationCode	string	Product activation code	O
— → discountPlan	order.DiscountPlan		O
— — → discountStep	integer (int32)	Step in the discount plan	R
— — → ignorePurchaseDiscount	boolean	Whether to ignore discount on the initial purchase	O
— — → tag	string	Plan designation tag	R
— → discountRate	number (double)	Discount rate applied	O
— → expirationDate	string (date-time)	Product expiration timestamp in ISO 8601 format	O
— → externalContext	string	External context data	R
— → extraTerm	order.ExtraTermBonusDetails		O
— — → extraTermBonusTag	string	Extra term bonus tag	R
— — → unit	string	Extra term bonus unit	R
— — → value	integer (int32)	Extra term bonus value	R
— → fulfillmentId	string	Fulfillment process identifier	O
— → id	string	Unique line item identifier	R
— → isUpsell	boolean	Upsell status marker	O
— → lineItemDataId	string	Line item data identifier	R
— → lineItemId	string	Line item identifier. For compatibility purposes.	O
— → pricing	order.Pricing		R
— — → allDiscountsApplied	com.nx.notification.externalapi.DiscountApplied[]	All discounts applied to this item	O
— — — → discountAmount	number (double)	Discount value	R
— — — → discountCode	string	Customer-facing discount code	O
— — — → discountId	string	Monetize discount identifier	R
— — — → discountRate	number (double)	Discount percentage, e.g. 0.2 for 20%	O
— — → cumulatedDiscountRate	number (double)	Total cumulated discount percentage	O
— — → unitPriceExclVAT	number (double)	Pre-tax unit cost	R
— — → unitPriceIncVAT	number (double)	Post-tax unit cost	R
— — → vatAmount	number (double)	Tax amount	O
— — → VATRate	number (double)	Tax rate percentage	R
— → priority	integer (int32)	Line item priority	O
— → product	order.Product		R
— — → name	string	Product name	R
— — → publisherReference	string	Publisher's internal product identifier	O
— — → uniqueReference	string	Unique product identifier on the Nexway Monetize platform	R
— → publisherFulfillmentId	string	Publisher fulfillment identifier	O
— → quantity	integer (int32)	Product quantity	R
— → subItems	order.SubItem[]	Nested line items	O
— — → activationCode	string		O
— — → externalContext	string		O
— — → fulfillmentId	string		O
— — → id	string		O
— — → product	order.Product		O
— — — → name	string	Product name	R
— — — → publisherReference	string	Publisher's internal product identifier	O
— — — → uniqueReference	string	Unique product identifier on the Nexway Monetize platform	R
— — → publisherFulfillmentId	string		O
— → subscription	subscription.Subscription		O
— — → createDate	string (date-time)	Creation date in ISO 8601 format	R
— — → discountPlan	subscription.DiscountPlan		O
— — — → nextDiscountStep	integer (int32)	Calculated next discount step value	R
— — — → startingStep	integer (int32)	Starting step	O
— — — → tag	string	Plan identifier	R
— — → enduserId	string	End-user UUID	R
— — → id	string	Subscription UUID	R
— — → lifecycle	subscription.LifeCycle		R
— — — → anniversaryDate	string (date-time)	Renewal/expiration date in ISO 8601 format	R
— — — → generation	integer (int32)	Renewal generation (term number)	R
— — — → id	string	Back-office subscription identifier (deprecated)	O
— — — → status	string	Status: Active, Suspended, Dunning, Canceled, Expired	R
— — → modelId	string	Model identifier, e.g. NEXWAY_1Y	R
— — → name	string	Product name	O
— — → paymentMethodIsNoLongerReplayable	boolean	Whether the payment method is no longer replayable	O
— — → paymentMethodIsNoLongerReplayableReason	string	Reason why the payment method is no longer replayable	O
— — → products	subscription.Product[]	Associated products	R
— — — → id	string	Product UUID	R
— — — → licenseId	string	License identifier	O
— — — → lineItemId	string	Order line item UUID	R
— — → source	string	Subscription source	O
— — → storeId	string	Store UUID	R
— → subscriptionId	string	Associated subscription identifier	O
— → trial	boolean	Trial status indicator	R
— → trialDuration	integer (int32)	Trial duration in days	O
— → unitPriceExclVAT	number (double)	Unit price excluding tax	R
— → unitPriceIncVAT	number (double)	Unit price including tax	R
— → VATRate	number (double)	Applied sales tax rate	R
→ offerCreationSource	string	Source context for offer creation coming from cart	O
→ offerSubSource	string	Sub-source designation, e.g. SUSPEND, RESUME	O
→ payment	order.Payment		O
— → amount	number (double)	Payment amount	O
— → automaticBilling	boolean	Whether the payment was automatically charged	R
— → externalContext	string	External context data	O
— → id	string	Payment identifier	R
— → lastError	order.LastPaymentError		O
— — → code	string	Error code	R
— — → message	string	Error description	O
— → method	string	Payment method, e.g. visa, mastercard, sepa, pix, boleto	O
— → silentOnFailure	boolean	Whether to suppress failure notifications	O
— → status	string	Payment status: COMPLETED, FAILED	R
— → transitionPaymentDate	string (date-time)	Transaction timestamp in ISO 8601 format	R
→ payments	order.Payment[]	All payment attempts	O
— → amount	number (double)	Payment amount	O
— → automaticBilling	boolean	Whether the payment was automatically charged	R
— → externalContext	string	External context data	O
— → id	string	Payment identifier	R
— → lastError	order.LastPaymentError		O
— — → code	string	Error code	R
— — → message	string	Error description	O
— → method	string	Payment method, e.g. visa, mastercard, sepa, pix, boleto	O
— → silentOnFailure	boolean	Whether to suppress failure notifications	O
— → status	string	Payment status: COMPLETED, FAILED	R
— → transitionPaymentDate	string (date-time)	Transaction timestamp in ISO 8601 format	R
→ refund	order.Refund		O
— → lineItems	order.RefundDetails[]		O
— — → initialAmount	number (double)		O
— — → productId	string		O
— — → productName	string		O
— — → ratio	number (double)		O
— — → refundAmount	number (double)		O
— — → refundMethod	string		O
— → totalAmountRefunded	number (double)		O
→ salesFlag	string[]	Sales flags	O
→ source	string	Order origin: PURCHASE, SUBSCRIPTION, OFFER, MANUAL_RENEWAL	R
→ status	string	Current order status	R
→ store	order.Store		R
— → id	string	Store identifier	R
→ totalPriceExclVAT	number (double)	Total price excluding sales tax	R
→ totalPriceIncVAT	number (double)	Total price including sales tax	R
→ user	order.EndUser		R
— → city	string	City	O
— → companyName	string	Company name	O
— → companyRegistrationNumber	string	Company registration number	O
— → country	string	Alpha-3 country code	R
— → email	string	Buyer email address	R
— → firstName	string	First name	O
— → id	string	Buyer identifier	R
— → language	string	Alpha-2 language code	O
— → lastName	string	Last name	O
— → region	string	Region	O
— → street	string	Street address	O
— → zipcode	string	Postal code	O

PackageThresholdReachedNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
customerName	string		O
licenseKeyPackage	lkp.Package		O
→ id	string		O
→ name	string		O
threshold	integer (int32)		O

PaymentMethodAddedNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
addedPaymentMethods	enduser.PaymentMethod[]	List of added payment instruments	R
→ type	string	Specific variant, e.g. visa, mastercard	R
→ _id	string	Unique payment method identifier	R
→ expirationDate	string	Expiration date	O
→ id	string	Payment method identifier	R
→ paymentMethodType	string	Broad classification, e.g. CreditCard	R
→ status	string	Activation state, e.g. ACTIVATED	R

ResellerNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
reseller	enduser.EndUser		O
→ type	string		O
→ city	string		O
→ company	enduser.Company		O
— → name	string		O
— → vatNumber	string		O
→ country	string		O
→ creationDate	string (date-time)		O
→ email	string		O
→ firstName	string		O
→ id	string		O
→ lastName	string		O
→ phone	string		O
→ status	string		O
→ streetAddress	string		O
→ zipCode	string		O

SubscriptionNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
subscription	subscription.Subscription		R
→ createDate	string (date-time)	Creation date in ISO 8601 format	R
→ discountPlan	subscription.DiscountPlan		O
— → nextDiscountStep	integer (int32)	Calculated next discount step value	R
— → startingStep	integer (int32)	Starting step	O
— → tag	string	Plan identifier	R
→ enduserId	string	End-user UUID	R
→ id	string	Subscription UUID	R
→ lifecycle	subscription.LifeCycle		R
— → anniversaryDate	string (date-time)	Renewal/expiration date in ISO 8601 format	R
— → generation	integer (int32)	Renewal generation (term number)	R
— → id	string	Back-office subscription identifier (deprecated)	O
— → status	string	Status: Active, Suspended, Dunning, Canceled, Expired	R
→ modelId	string	Model identifier, e.g. NEXWAY_1Y	R
→ name	string	Product name	O
→ paymentMethodIsNoLongerReplayable	boolean	Whether the payment method is no longer replayable	O
→ paymentMethodIsNoLongerReplayableReason	string	Reason why the payment method is no longer replayable	O
→ products	subscription.Product[]	Associated products	R
— → id	string	Product UUID	R
— → licenseId	string	License identifier	O
— → lineItemId	string	Order line item UUID	R
→ source	string	Subscription source	O
→ storeId	string	Store UUID	R

TaxRateNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
taxRate	taxManager.TaxRate		O
→ iso2CountryCode	string	ISO 3166-1 alpha-2 country code, e.g. FR, CA	R
→ regionCode	string	Region or province code, e.g. CA-QC. Present only if the rate applies to a specific region	O
→ startDate	string (date-time)	Planned activation time as a Unix epoch timestamp (milliseconds). Present only for scheduled tax rate change events	O
→ taxRates	taxManager.TaxRateDetail[]	Array of tax rate entries. For multi-rate countries the array contains one entry per tax category	R
— → taxCategory	string	Tax category identifier, e.g. STANDARD, FEDERAL, STATE, VAT	R
— → taxName	string	Human-readable name of the tax, e.g. Federal Tax, QST	O
— → value	number (double)	Tax rate as a decimal, e.g. 0.05 for 5%	R

TextNotification

Field	Type	Description	R/O
text	string		O

cart.CartNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
cart	cart.Cart		R
→ country	string	Cart country	R
→ createDate	integer (int64)		O
→ creationDate	string (date-time)	The date when cart was created	R
→ customer	cart.Customer		R
— → id	string	Customer id associated to the cart	R
— → name	string	Customer name associated to the cart	R
→ customerId	string		O
→ decodedExternalContext	object	Decoded map of cart string parameters if they were provided in the json format	O
→ externalContext	string	Base64 encoded string of cart parameters	O
→ id	string	Cart unique identifier	R
→ locale	string	Cart locale	R
→ price	cart.Price		R
— → currency	string	Cart price currency	R
— → grossPrice	number (double)	Total price of a cart, including sales tax	R
— → netPrice	number (double)	Total price of a cart, excluding sales tax	R
→ products	cart.Product[]	List of products in cart	R
— → businessSegment	string	Product business segment: b2c, b2b, STRICT b2b and STRICT b2c	R
— → discountPlan	cart.DiscountPlan		O
— — → discountStep	integer (int32)	Subscription discount plan step is used on acquisition	R
— — → ignorePurchaseDiscount	boolean	Only in case if this flag was set on acquisition	O
— — → tag	string	Subscription discount plan tag	R
— → expirationDate	string (date-time)	Product license expiration date	O
— → extraTerm	cart.ExtraTermBonus		O
— — → extraTermBonusTag	string	Extra term bonus tag	R
— — → unit	string	Extra term bonus unit: "months" or "days"	R
— — → value	integer (int32)	Number of extra term bonus units	R
— → fulfillmentTemplate	string	Fulfillment template ID in Monetize	O
— → gift	boolean	Boolean indicating if product is gift	R
— → id	string	Unique ID for a product in the cart	R
— → name	string	Product name	R
— → parentId	string	Product parent ID (Unique ID of parent product in Monetize)	R
— → productFamily	string	Product family name	O
— → publisherRefId	string	A unique ID for identifying your product in your information system, if defined	O
— → quantity	integer (int32)	Product quantity	R
— → subscriptionProduct	boolean	Boolean indicating if product is sold by subscription model	R
— → subscriptionTemplate	string	Subscription template name in Monetize	O
— → taxExempt	boolean	Boolean indicating if product has tax exemption	R
— → trial	boolean	Boolean indicating if product is trial	R
— → unitPrice	cart.UnitPrice		R
— — → discountedPrice	cart.DiscountedPrice		O
— — — → allDiscountsApplied	cart.Discount[]	Array of all applied discounts. Each discount represented as object	R
— — — — → discountAmount	number (double)	Amount of discount	O
— — — — → discountCode	string	Discount code (if any)	O
— — — — → discountId	string	Identifier of discount in Monetize	R
— — — — → discountRate	number (double)	Discount rate, f.e. 0.2	O
— — — → cumulatedDiscountRate	number (double)	Discount rate applied to product	O
— — — → discountedGrossPrice	number (double)	Discounted unit price, including sales tax	R
— — — → discountedNetPrice	number (double)	Discounted unit price, excluding sales tax	R
— — → grossPrice	number (double)	Product unit price, including sales tax	R
— — → netPrice	number (double)	Product unit price, excluding sales tax	R
— — → vatAmount	number (double)	Vat amount	O
— — → VATRate	number (double)	Sold product applied sales tax rate	R
— → upsell	boolean	Boolean indicating if product was upsold or not	R
→ scenario	string	Cart scenario: acquisition, retention, etc	O
→ source	string	Cart source: PURCHASE, SUBSCRIPTION, OFFER, MANUAL_RENEWAL, etc	R
→ storeId	string	Store id from the cart	R

subscription.PaymentMethodReplayabilityChangedNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
paymentMethod	subscription.PaymentMethod		O
→ type	string	Specific variant, e.g. visa, mastercard	R
→ expirationDate	string	The expiration date of the payment method mm/YY	O
paymentMethodNonReplayable	boolean		O
reasonDescription	string		O
warningReason	string		O

subscription.PaymentMethodUpdatedNotification

Field	Type	Description	R/O
subject	string	Notification subject, e.g. order, subscription, endUser	R
type	string	Event type, e.g. created, completed, paymentFailed	R
objectId	string	Unique identifier of the object that triggered the event	R
eventDate	string (date-time)	Timestamp of the event in ISO 8601 format	R
endUser	subscription.EndUser		R
→ expirationDate	string	The expiration date of the payment method mm/YY	O
→ id	string	The end user id	R
→ paymentMethod	string	Broad classification, e.g. CreditCard	O
→ paymentMethodName	string	Specific variant, e.g. visa, mastercard	O
→ subscriptionId	string	The subscription Id	R

Auto-generated from OpenAPI extension file by scripts/generateNotificationDocs.js