Event

Certain events are recorded in the Billwerk+Optimize system and are the triggers for sending mails and issuing webhooks. An event is tied to one or more of the main resources: customer, subscription and invoice. An event can be tied to several resources, e.g. an event tied to invoice will also be tied to customer and for subscription invoices also to a subscription.

Invoice events

EventDescription
invoice_createdInvoice has been created
invoice_settledInvoice has been settled
invoice_authorizedInvoice has been authorized
invoice_dunningInvoice has entered dunning state
invoice_dunning_notificationTime for sending dunning notification acording to dunning plan
invoice_dunning_cancelledAn ongoing dunning process has been cancelled either because the invoice has been settled or because the invoice has been cancelled
invoice_failedInvoice has failed. A failed may later be authorized, settled, cancelled or fail again. For subscription invoices due to an unsuccessful dunning process or because of instant ondemand settle fail.
invoice_refundA refund has been performed on a settled invoice
invoice_refund_failedFor asynchronous refund this event will be fired if the refund fails. An asynchronous refund will be indicated by the refund state processing when performing the refund.
invoice_reactivateA failed or cancelled invoice has been reactivated to state pending for processing
invoice_cancelledInvoice has been cancelled
invoice_changedState has not changed but other attributes on the invoice has changed. E.g. settle later cancel.
invoice_creditedInvoice has been credited by creating attached an credit note and creating a subscription credit

Subscription events

EventDescription
subscription_createdSubscription has been created
subscription_payment_method_addedA payment method has been added to the subscription for the first time
subscription_payment_method_changedThe payment method has been changed for a subscription with an existing payment method
subscription_trial_endThe trial period for subscription has ended
subscription_renewalAn invoice has been made and new billing period has started for subscription
subscription_cancelledSubscription has been cancelled to expire at end of current billing period
subscription_uncancelledA previous cancellation has been cancelled
subscription_on_holdSubscription has been put on hold by request
subscription_on_hold_dunningSubscription has been put on hold due to a failed dunning process
subscription_reactivatedSubscription on hold has been reactivated to active state
subscription_expiredSubscription has expired either by request, end of fixed life time or because cancelled and billing period has ended
subscription_expired_dunningSubscription has expired due to a failed dunning process
subscription_changedSubscription scheduling or pricing has been changed, e.g. by changed plan or changed next period start

Customer events

EventDescription
customer_createdCustomer has been created
customer_changedCustomer information has been changed
customer_deletedCustomer has been deleted
customer_payment_method_addedA payment method has been added to customer
customer_payment_method_failedPayment method has entered failed state and should not be used again for future payments
customer_payment_method_updatedPayment method has been updated, e.g. for EMV tokens when the underlying card changes resulting in new masked card number and changed expiry date.
customer_payment_method_reactivatedFailed payment method is put back to state active. Can happen for EMV tokens if a suspended token is resumed. Can happen for credit cards if a faild card is retried with success.
customer_payment_method_deletedA payment method has been deleted in the Admin or with API call