Email logs

Email logs represent emails sent through Chargebee, including send invoice email, send credit note email, and send payment request email.

These objects are returned in the async result.email_logs array when a send-email operation completes successfully. Use List email logs for a customer to retrieve emails already sent for a customer. There is no standalone retrieve API for a single email log.

Sample Email logJSON

Email logs attributes

required, string, max chars=40

Unique identifier of this email.

template_name

optional, string, max chars=100

Name of the notification / email template that was sent.

from_address

required, string, max chars=254

The from email address used for this email.

to_address

required, string, max chars=254

The recipient email address.

subject

required, string, max chars=500

Subject line of the email.

status

required, enumerated string

Status of the email.

Enum Values

scheduled

The email has been scheduled for delivery.

rescheduled

The email was rescheduled for delivery.

succeeded

The email was sent successfully.

failed

Sending the email failed.

deferred

The email was deferred.

delivered

The email was delivered to the recipient.

opened

The recipient opened the email.

bounced

The email bounced.

dropped

The email was dropped and not delivered.

sent_on

optional, timestamp(UTC) in seconds

The time the email was scheduled to be sent, as a Unix timestamp in seconds.

customer_id

optional, string, max chars=50

The unique identifier of the customer associated with this email.

email_conversation_id

optional, string, max chars=40

site_id

optional, string, max chars=60

Unique identifier of the Chargebee site where this email was sent. This value does not change if the site is renamed.

business_entity_id

optional, string, max chars=50

The unique ID of the business entity this email was sent under. Returned only when Multi Business Entity is enabled for the site.

brand_id

optional, string, max chars=50

The unique ID of the brand this email was sent as. Returned only when Multi Brand is enabled for the site.

error_message

optional, string, max chars=1500

Error message when the email could not be sent, was deferred, bounced, or dropped.