Skip to main content

Standard Events

Zuora

Standard Events

Standard events are pre-defined business events for Zuora Billing, Zuora Payment, and Zuora Finance. Zuora provides you with the supported standard events out of the box.

Supported standard events

To view the standard events supported in the application:

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

See the supported standard events for Zuora Orders, Zuora Billing, Zuora Payment, and Zuora Finance below.

Standard events for Zuora Orders

The following table describes the standard events supported by Zuora Orders. If you want to enable Orders and the associated standard events, submit a request at Zuora Global Support. Once they are enabled, Zuora will provide you with these standard events and corresponding notifications out of the box.

Note that these events and corresponding notifications are only available for the default communication profile.

Name Related Event Description
Order Processed Order Processed Notification sent out when an order has been processed.
Add Product  Order Action Processed Notification sent out when a product is added to an order.
Cancel Subscription  Order Action Processed Notification sent out when a subscription is canceled.

Create Subscription 

Order Action Processed Notification sent out when a subscription is created.
Owner Transfer  Order Action Processed Notification sent out when the invoice owner or subscription owner is changed.
Remove Product  Order Action Processed Notification sent out when a product is removed.
Renew Subscription  Order Action Processed Notification sent out when a product is renewed.
Terms and Conditions  Order Action Processed Notification sent out when changes happened to the terms and conditions of a subscription.
Update Product  Order Action Processed Notification sent out when a product is updated.

Standard events for Zuora Billing

The following table describes the standard events supported by Zuora Billing.

Note that if you have the Orders feature enabled, the standard events and notifications in the following table are not available to you. However, if you have both the Orders and the Orders Harmonization features enabled, for any subscription creation or amendment created through Subscribe and Amend APIs, the following events and notifications will continue to work.

  • The AmendmentProcessed event and corresponding notifications
  • The New Subscription Created event and corresponding notifications.
Name Related Event Description
Cancellation AmendmentProcessed A subscription cancelation amendment has been submitted and processed.
NewProduct AmendmentProcessed An "add new product" amendment has been submitted and processed.
Owner Transfer AmendmentProcessed An Owner Transfer amendment has been submitted and processed.
RemoveProduct AmendmentProcessed A remove product amendment has been submitted and processed.
Renewal AmendmentProcessed A renewal amendment has been submitted and processed.

Resume Subscription

AmendmentProcessed

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.

Suspend Subscription

AmendmentProcessed

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. 

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

Completed Status

Bill Run Completion

A bill run has completed successfully.

Error Status

Bill Run Completion

A bill run has not completed successfully.

Completed Status

Billing Preview Run Completion

A billing preview run has completed successfully.

Error Status

Billing Preview Run Completion

A billing preview run has completed with error.

Completed Status DataSource Export Completion A data source export has completed. 
Completed Status Import Processed An import of usage records has completed successfully. See Adding Usage Data for more information. 
Error Status Import Processed An import of usage records has not completed successfully. 

Day(s) Before/After Invoice Due Date

Invoice Due

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 UTC for EU/US Cloud Sandbox and Production tenants, or 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

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

Invoice Posted Manually Invoice Posted

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 via API Invoice Posted Generate an event when a draft invoice is posted via API.
Invoice Posted within a Bill Run of Auto-Post Invoice Posted 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 UTC for EU/US Cloud Sandbox and Production tenants, or 4:15 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Contract Effective Date Key Date(s)

A subscription notification is sent on the contract effective date.

This event only monitors the Contract Effective Date field on the Subscription object. An Amendment or Order that changes an existing subscription but does not change the Contract Effective Date field will not trigger this event.

This notification is triggered by a scheduled job at 9:45 am UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Customer Acceptance Date Key Date(s)

A subscription notification is sent on the customer acceptance date.

This notification is triggered by a scheduled job at 9:45 am UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Rate Plan Charge End Date Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments. 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.

Rate Plan Charge Start Date Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 8:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments. 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.

Service Activation Date Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Subscription End Date Key Date(s) A subscription notification is sent on the subscription end date at 9:45 am UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.
Subscription Resume Date Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

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.

Subscription Start Date Key Date(s) A subscription notification is sent on the subscription start date at 9:45 am UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments. This is the term start date of the original subscription.

Subscription Suspend Date

Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

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.

Term End Date Key Date(s)

A subscription notification is sent on the term end date.

This notification is triggered by a scheduled job at 9:45 am UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Term Start Date Key Date(s)

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 UTC for EU/US Cloud Sandbox and Production tenants, or 9:45 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Manual Email For Invoice Manual Email For Invoice Send email notification manually from invoice detail page.
Active New Subscription Created A new subscription has been created and activated.
Pending Acceptance New Subscription Created A new subscription has been created and is in Pending Acceptance status.
Pending Activation New Subscription Created A new subscription has been created and is in Pending Activation status.
30 days before auto renewal Upcoming 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 UTC for EU/US Cloud Sandbox and Production tenants, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

30 days before renewal Upcoming Renewal

The subscription is within 30 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am UTC for EU/US Cloud Sandbox and Production tenants, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

60 days before renewal Upcoming Renewal

The subscription is within 60 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am UTC for EU/US Cloud Sandbox and Production tenants, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

90 days before renewal Upcoming Renewal

The subscription is within 90 days of its scheduled renewal.

This notification is triggered by a scheduled job at 00:01 am UTC for EU/US Cloud Sandbox and Production tenants, or 00:01 am Los Angeles time (UTC-07:00 or UTC-08:00 depending on the time of the year) for tenants in other environments.

Standard events for 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 standard events supported by Zuora Payments.

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

The gateway reconciliation job has completed.

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

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

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.

30 Day Warning Payment Method Expiration

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.

Manually Payment Method Updated

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.

API Payment Method Updated

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.

By Payment Method Updater Payment Method Updated

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.

Manually Payment Method Closed The payment method was closed by a system user.
API Payment Method Closed The payment method was closed by a system user.
By Payment Method Updater Payment Method Closed The payment method was closed by the Payment Method Updater
Payment Method Updater Batch Started Payment Method Updater Batch Started A payment method updater batch was started.
Payment Method Updater Batch Completed 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.
Completed Status Payment Run Completion Payment run is completed successfully.
Error Status Payment Run Completion Payment run is completed with error.
External Credit Balance Refund Processed Credit Balance Refund Processed The external credit balance refund was processed successfully.
External Payment Refund Processed Payment Refund Processed The external payment refund was processed successfully. 
External Payment Processed Payment Processed The external payment was processed successfully.

Credit memo and debit memo events

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

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

Credit Memo Posted Manually  Credit Memo Posted

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

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.

Credit Memo Refund Processed Credit Memo Refund Processed Trigger the notification when a credit memo is refunded successfully. 
External Credit Memo Refund Processed Credit Memo Refund Processed Trigger the notification when an external credit memo is refunded successfully. 
Debit Memo Created Manually from Invoice Debit Memo Created Trigger the notification when a debit memo is created from an invoice through the Zuora UI.
Debit Memo Created Manually from Product Rate Plan Charge Debit Memo Created

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

Debit Memo Posted Manually Debit Memo Posted 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 via API  Debit Memo Posted Trigger the notification when a debit memo is posted through the Zuora REST API.
Manually email Credit Memo Email Credit Memo Send email notification and credit memo PDF from the credit memo detail page in the Zuora UI.
Manually email Debit Memo Email Debit Memo Send email notification and credit memo PDF manually from the debit memo detail page in the Zuora UI.

Standard events for Zuora Finance

The following table describes the standard events supported by Zuora Finance.

Name Related Event Description
Journal Run Completed Status Journal Run Completion Notification sent out when a journal run has completed successfully.
Journal Run Error Status Journal Run Completion Notification sent out when a journal run encounters an error.
Trial Balance Completed Status Trial Balance Completion Notification sent out when a trial balance has completed successfully.
Trial Balance Error Status Trial Balance Completion Notification sent out when a trial balance encounters an error.

Use Cases

Configure email notifications for Upcoming Renewal standard event

​Zuora gives you the ability to send automated email notifications to customers for upcoming subscription renewals.

For subscriptions with auto-renew disabled, the subscription stops billing once the subscription term expires. Therefore, you must work with your customers in advance to renew the subscription and avoid a lapse in services. It is best practice to provide non auto-renewal customers with ample notice in case they want to make any changes to their subscription.

For subscriptions with auto-renew enabled, because the customer opted for auto-renewal when they signed up for your service, advanced notification is an optional courtesy.

The following solution shows you how to configure Zuora to automatically send customers an email notification when their subscription is coming up for renewal.

In Zuora, navigate to Settings > Z-Billing Settings Setup Profiles, Notifications and Email Templates. Then follow these steps:

  1. Click add new notification.

    1_addNewNotifcation.png

    The Add New Notification panel is displayed.

    AddNewNotification.png

  2. Configure the notification as follows.
    Field Description

    Related Event

    Select Upcoming Renewal.

    Name

    Give the notification a name.

    Description

    Optionally enter a description of the notification.

    Active

    Select the check box to make the notification active.

    Auto-Renewal

    Select whether you want to notify customers with auto-renew enabled (true) or disabled (false).

    In this example, select false to notify only customers whose subscriptions are set not to auto-renew.

    How Many Days Before

    Enter the number of days before renewal that you want to notify the customer. Enter anywhere from 1 to 90 days.

    Email

    Select the check box so that customers will be notified by email.

    Select an email template from the drop-down menu. The drop-down menu displays the default templates and any custom templates you have created for upcoming renewals. The email template determines the email sent to customers. See Creating Email Templates for more information about how to create custom templates.

    In this example, select Upcoming Renewal Default Email Template (Manual Renewal).

    Click add new notification to complete the configuration. Your new notification appears on the Define Notification list. See Create and Edit Notifications for more information about configuring notifications.

  3. To view and edit the email template, click on the email template name to the right of the new notification in the Define Notification list. The email template page is displayed.

    4_EditEmailTemplate.png

  4. Edit the email template information as required. See Creating Email Templates for more information.
  5. Scroll to the bottom of the email template page to see the email subject and body, as well as the available merge fields. Edit the email text and use the merge fields to personalize the email that each customer receives. See Email Template Merge Fields for more information.

    5_EditEmailBody.png

  6. Click save.