The customer email object defines the email messages and preferences a customer should receive. Messages include "Credit Card Expiry Notices", "Invoice Overdue Notices" and others.
Currently, there are preference entities for the following emailTypes
InvoicePostPaymentReceivedInvoiceOverduePasswordResetPaymentFailedCustomerActivationSubscriptionActivationSubscriptionCancellationCustomerCredentialCreateCustomerCredentialPasswordResetCustomerSuspendPaymentMethodUpdateCreditCardExpiryStatementNotificationUpcomingBillingNotificationRefundPendingExpiryRenewalNotice
Additional preference entities may be added in the future so when editing the email preferences via the API it is suggested to always perform a GET to retrieve the full email preferences list and to then modify the data in that list and PUT that list to perform the edit action. This ensures the PUT action includes all the required preference entities.
Customer Email Preferences Fields
| Field | Type | Description |
|---|---|---|
customerId | Integer | This is the Stax Bill generate PaymentRece |
preferences | List of Objects (definition below) | This is the list of Preference entities. |
Preferences Object Fields
| Field | Type | Description |
|---|---|---|
enabled | String | Specify whether or not the specified email notification is enabled. Values should be one of: true, false or NULL (account default) |
accountDefault | Boolean | The default preference across the account. To be used if
|
emailType | Enum:{InvoicePost, PaymentReceived, InvoiceOverdue, PasswordReset, PaymentFailed, CustomerActivation, SubscriptionActivation, SubscriptionCancellation, CustomerCredentialCreate, CustomerCredentialPasswordReset, CustomerSuspend, PaymentMethodUpdate, CreditCardExpiry, StatementNotification, UpcomingBillingNotification, Refund, PendingExpiryRenewalNotice} | Used to specify which email notification. Valid values are any of the following:
|
emailCategory | String | Describes the general category of the email. Mostly for internal use. nvoicePost` |