Knowledge Center

Knowledge Center > Admin > Notifications > Supported Event Types

Supported Event Types

View Event Types

To view the notification events supported in the application:

  1. Click your user name and select Settings.
  2. Select the application: Billing, Payments, or Finance.
  3. Click Setup Profiles, Notifications and Email Templates.

Notification Event Types Supported by Zuora Billing

The following table describes the event types supported by Zuora Billing.

Event Description
AmendmentProcessed | Cancellation A subscription cancelation amendment has been submitted and processed.
AmendmentProcessed | NewProduct An "add new product" amendment has been submitted and processed.
AmendmentProcessed | Owner Transfer A Owner Transfer amendment has been submitted and processed.
AmendmentProcessed | RemoveProduct A remove product amendment has been submitted and processed.
AmendmentProcessed | Renewal A renewal amendment has been submitted and processed.

AmendmentProcessed | Suspend Subscription

A Suspend Subscription amendment has been submitted and processed.

The AmendmentProcessed notification for Suspend Subscription amendment is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature. 

AmendmentProcessed | Resume Subscription

A Resume Subscription amendment has been submitted and processed.

The AmendmentProcessed notification for Resume Subscription amendment is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.

AmendmentProcessed | TermsAndConditions A term and condition amendment has been submitted and processed.
AmendmentProcessed | UpdateProduct An update product amendment has been submitted and processed.

Bill Run Completion | Completed Status

A bill run has completed successfully.

Bill Run Completion | Error Status

A bill run has not completed successfully.

DataSource Export Completion | Completed Status A data source export has completed. 

Billing Preview Run Completion | Completed Status

A billing preview run has completed successfully.

Billing Preview RunCompletion | Error Status

A billing preview run has completed with error.

Import Processed | Completed Status An import of usage records has completed successfully. See Adding Usage Data for more information. 
Import Processed | Error Status An import of usage records has not completed successfully. 

Invoice Due | Day(s) Before/After Invoice Due Date

This event sends a notification for each invoice that matches the criteria for the Invoice Due Date. You can choose the number of days before or after the invoice due date to send the notification, and you can create multiple notifications. For example, you can send notifications at 5, 7, and 10 days past due.

This notification is triggered by a scheduled job at 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Please also see Invoices Past Due, Account Summary notification for an Account-level notification of all overdue invoices on an account.

Invoice Posted | Invoice Posted Manually

Generate an event when a draft invoice is posted manually from the invoice detail page.

This event will trigger a notification when you click post in a Bill run page. This also allows you to manually trigger a notification when you click post invoice from the individual (draft) invoice's page in the Zuora UI. 

Invoice Posted | Invoice Posted via API Generate an event when a draft invoice is posted via API.
Invoice Posted | Invoice Posted within a Bill Run of Auto-Post Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run.
Invoices Past Due, Account Summary | Invoices past due, account summary

Summary information of past due posted invoices of customer accounts, generally delivered on monthly basis.

The invoice past due event applies to the account level, rather than the invoice level. The past due invoices will be checked first, and if any exist they will be included in a single notification. The past due calculation is performed according to the relevant date fields on invoices, not on the account.

The time when the notification is sent is determined according to the account's billing day or a specific day of this month. To set a specific day of the month, edit the notification and set the Notification delivery day.

This notification is triggered by a scheduled job at 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Manual Email For Invoice | Manual Email For Invoice Send email notification manually from invoice detail page.
New Subscription Created | Active A new subscription has been created and activated.
New Subscription Created | Pending Activation A new subscription has been created and is in Pending Activation status.
New Subscription Created | Pending Acceptance A new subscription has been created and is in Pending Acceptance status.
Key Date(s) | Contract Effective Date

A subscription notification is sent on the contract effective date.

This notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Key Date(s) | Customer Acceptance Date

A subscription notification is sent on the customer acceptance date.

This notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Key Date(s) | Service Activation Date

A subscription notification is sent on the activation date for services or products within a subscription. 

This notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Key Date(s) | Subscription End Date A subscription notification is sent on the subscription end date at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.
Key Date(s) | Subscription Start Date A subscription notification is sent on the subscription start date at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone. This is the term start date of the original subscription.

Key Date(s) | Subscription Suspend Date

A subscription notification is sent on the date when subscription suspension takes effect.

The notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

The Key Date(s) notification for Suspend Subscription is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.

Key Date(s) | Subscription Resume Date

A subscription notification is sent on the date when subscription resumption takes effect.

The notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

The Key Date(s) notification for Resume Subscription is in Limited Availability. If you already have Suspend and Resume feature enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Suspend and Resume feature.

Key Date(s) | Term End Date

A subscription notification is sent on the term end date.

This notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Key Date(s) | Term Start Date

A subscription notification is sent on the term start date. By default, the contract effective date is set to be the term start date.

This notification is triggered by a scheduled job at 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Key Date(s) | Rate Plan Charge End Date

A rate plan charge notification is sent on the date when a charge ends. 

The notification is triggered by a scheduled job at 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone. If the subscription is cancelled before today's date, the notification will not be sent. 

When you are creating or editing a notification, you can set when to notify your customers by offsetting the number of days in the Offset field.

This event type is only for subscriptions that are in PendingActivation, PendingAcceptance, Active, or Cancelled status.

The Key Date(s) notification for Rate Plan Charge End Date is in Limited Availability. If you already have Key Date(s) notification for Rate Plan Charge enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Rate Plan Charge Key Date(s) Notification.

Key Date(s) | Rate Plan Charge Start Date

A rate plan charge notification is sent on the date when a charge starts. 

The notification is triggered by a scheduled job at 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone. If the subscription is cancelled before today's date, the notification will not be sent.

When you are creating or editing a notification, you can set when to notify your customers by offsetting the number of days in the Offset field.

This event type is only for subscriptions that are in PendingActivation, PendingAcceptance, Active, or Cancelled status.

The Key Date(s) notification for Rate Plan Charge Start Date is in Limited Availability. If you already have Key Date(s) notification for Rate Plan Charge enabled, this notification is available automatically. Submit a request at Zuora Global Support only if you wish to have access to Rate Plan Charge Key Date(s) Notification.

Upcoming Renewal | 30 days before auto renewal

The subscription is within 30 days of its scheduled renewal and the subscription will be automatically renewed.

This notification is triggered by a scheduled job at 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Upcoming Renewal | 30 days before renewal

The subscription is within 30 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Upcoming Renewal | 60 days before renewal

The subscription is within 60 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Upcoming Renewal | 90 days before renewal

The subscription is within 90 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year), regardless of your tenant time zone.

Notification Event Types Supported by Zuora Payments

Payment notifications (processed and declined) are for electronic payments only, whether the payment was created by API or UI. External payments will not trigger these notifications.

The following table describes the event types supported by Zuora Payments.

Event Description
Credit Balance Refund Processed | Credit Balance Refund Processed A credit balance refund was processed successfully. 
Gateway Reconciliation Job Completion

The gateway reconciliation job has completed.

This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

Manual Email For Payment Send email notification manually from payment detail page.
Payment Declined | First Attempt The payment was declined by the payment gateway upon the first attempt.
Payment Method Expiration | 15 Day Warning

The credit card set as the default payment method on the account is within 15 days of expiration.

This notification is sent even if the payment method has been closed. Zuora recommends not leaving a closed payment method as the default on an account.

Payment Method Expiration | 30 Day Warning

The credit card set as the default payment method on the account is within 30 days of expiration.

This notification is sent even if the payment method has been closed. Zuora recommends not leaving a closed payment method as the default on an account.

Payment Method Updated | Manually

The payment method was updated by a system user.

A notification is sent only when the default payment method is updated, not other payment methods.

Payment Method Updated | API

The payment method was updated by a system user.

A notification is sent only when the default payment method is updated, not other payment methods.

Payment Method Updated | By Payment Method Updater

The payment method was updated by the Payment Method Updater.

A notification is sent only when the default payment method is updated, not other payment methods.

Payment Method Closed | Manually The payment method was closed by a system user.
Payment Method Closed | API The payment method was closed by a system user.
Payment Method Closed | By Payment Method Updater The payment method was closed by the Payment Method Updater
Payment Method Updater Batch Started A payment method updater batch was started.
Payment Method Updater Batch Completed A payment method updater batch was completed.
Payment Processed | Payment Processed

The payment was processed successfully.

Payment Refund Processed | Payment Refund Processed A payment refund was processed successfully.
Payment Run Completion | Completed Status Payment run is completed successfully.
Payment Run Completion | Error Status Payment run is completed with error.
Credit Balance Refund Processed | External Credit Balance Refund Processed The external credit balance refund was processed successfully.
Payment Refund Processed | External Payment Refund Processed The external payment refund was processed successfully. 
Payment Processed | External Payment Processed The external payment was processed successfully.

Credit memo and debit memo events

This feature is only available if you have the Advanced AR Settlement feature enabled. The Advanced AR Settlement feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support

Credit Memo Created | Credit Memo Created Manually from Invoice Trigger the notification when a credit memo is created from an invoice through the Zuora UI.
Credit Memo Created | Credit Memo Created Manually from Product Rate Plan Charge 

Trigger the notification when a credit memo is created from product rate plan charges through the Zuora UI.

Credit Memo Posted | Credit Memo Posted Manually 

Trigger the notification when a credit memo is posted from the credit memo detail page or the credit memo list page in the Zuora UI.

Credit Memo Posted | Credit Memo Posted via API  Trigger the notification when a credit memo is posted through the Zuora REST API.
Credit Memo Posted | Credit Memo Posted within a Bill Run of Auto-Post

Trigger the notification when a credit memo is posted within a bill run and the bill run has auto-post. This is to support the existing email notification behavior from within a bill run.

Debit Memo Created | Debit Memo Created Manually from Invoice Trigger the notification when a debit memo is created from an invoice through the Zuora UI.
Debit Memo Created | Debit Memo Created Manually from Product Rate Plan Charge

Trigger the notification when a debit memo is created from product rate plan charges through the Zuora UI.

Debit Memo Posted | Debit Memo Posted Manually Trigger the notification when a debit memo is posted from the debit memo detail page or the debit memo list page in the Zuora UI.
Debit Memo Posted | Debit Memo Posted via API  Trigger the notification when a debit memo is posted through the Zuora REST API.
Email Credit Memo | Manually email Credit Memo Send email notification and credit memo PDF from the credit memo detail page in the Zuora UI.
Email Debit Memo | Manually email Debit Memo Send email notification and credit memo PDF manually from the debit memo detail page in the Zuora UI.

Notification Event Types Supported by Zuora Finance

The following table describes the event types supported by Zuora Finance.

Event Description
Journal Run Completion | Journal Run Completed Status Notification sent out when a journal run has completed successfully.
Journal Run Completion | Journal Run Error Status Notification sent out when a journal run encounters an error.
Trial Balance Completion | Trial Balance Completed Status Notification sent out when a trial balance has completed successfully.
Trial Balance Completion | Trial Balance Error Status Notification sent out when a trial balance encounters an error.
Last modified
22:37, 10 May 2017

Tags

Classifications

(not set)