Event Smarty Tags Reference

CUSTOMER CREATED

event name: customer_created
usage: This means this customer has been created.

CUSTOMER UPDATED

event name: customer_updated
usage: This means this customer has been updated.
attached smarty tags for both events:

[
  'first_name',
  'last_name',
   'email'
];

CUSTOMER PASSWORD RESET

event name: customer_reset_password
usage: This means that the customer has requested a password reset and you need to send him a link that contains the password token. Below is an example of how you should build the link based on the user email and the password token.
example: https://www.yourdomain.com?view=password-reset&email={$email} &token={$token}
attached smarty tags:

[
  'first_name',
  'last_name',
  'email',
    'token
];

SUBSCRIPTION CREATED

event name: subscription_created
usage: This event is triggered when a new subscription has been created for a customer.

SUBSCRIPTION UPDATED

event name: subscription_updated
usage: This event is triggered when the customer subscription has been updated.

SUBSCRIPTION CANCELED

event name: subscription_canceled
usage: This means this customer has canceled a subscription

SUBSCRIPTION TRIAL WILL END

event name: subscription_trialwillend
usage: This means the subscription's trial period will end in three days, or when a trial is ended immediately.

SUBSCRIPTION RENEWED

event name: subscription_renewed
usage: This means this customer has renewed his subscription..

SUBSCRIPTION EXPIRED

event name: subscription_expired
usage: This means this customer's subscription was expired.

attached smarty tags for the subscription events:

[
  'id',
  'site_id',
  'address_id',
  'backdate_start_date',
  'billing',
  'billing_cycle_anchor',
  'cancel_at',
  'cancel_at_period_end',
  'canceled_at',
  'cancel_reason',
  'created',
  'current_period_end',
  'current_period_start',
  'days_until_due',
  'ended_at',
  'quantity',
  'shipments_remaining',
  'source',
  'status',
  'trial_end',
  'trial_start',
  'shipments_undeliverable',
  'shipments_suspended_until',
  'is_gift_donor',
  'is_gift_recipient',
  'gift_code',
  'is_redeemed',
  'gift_recipient_email',
  'gift_recipient_first_name',
  'gift_recipient_last_name',
  'gift_start_date',
  'gift_donor_subscription_id',
  'agency_id',
  'updated_at',
  'latest_invoice_id',
  'subscription_plan_name',
  'subscription_product_name'
];

INVOICE CREATED

event name: invoice_created
usage: This means this customer has a new invoice

INVOICE PAYMENT SUCCEEDED

event name: invoice_payment_succeeded
usage: This means the customer's attempt to pay an invoice was succeeded.

INVOICE PAYMENT FAILED

event name: invoice_payment_failed
usage: This means the customer's attempt to pay an invoice was FAILED.

attached smarty tags:

[
  'id',
  'amount_due',
  'amount_paid',
  'amount_remaining',
  'billing',
  'billing_reason',
  'currency',
  'created',
  'ending_balance',
  'finalized_at',
  'invoice_pdf',
  'marked_uncollectible_at',
  'paid_at',
  'period_end',
  'period_start',
  'post_payment_credit_notes_amount',
  'pre_payment_credit_notes_amount',
  'starting_balance',
  'status',
  'total',
  'voided_at',
  'updated_at',
  'number',
];

CHARGE SUCCEEDED

event name: charge_succeeded
usage: This means the attempt of charging the customer succeeded and a charge is created.

CHARGE FAILED

event name: charge_failed
usage: This means the attempt of charging the customer failed.

CHARGE REFUNDED

event name: charge_refunded
usage: This means the attempt of refunding a charge to the customer was succeeded. And the customer was refunded.

attached smarty tags for the charge events:

[
  'id',
  'agency_id',
  'invoice_id',
  'source_id',
  'user_id',
  'amount',
  'amount_refunded',
  'by_agency',
  'created',
  'currency',
  'description',
  'failure_code',
  'failure_message',
  'offline',
  'origin',
  'paid',
  'receipt_email',
  'receipt_number',
  'receipt_url',
  'reference',
  'refunded',
  'remit_rate',
  'remit_rate_amount',
  'statement_descriptor',
  'status',
  'refunded_at',
  'created_at',
  'updated_at',
];

ADDRESS CREATED

event name: address_created
usage: This means this customer has added a new address

ADDRESS UPDATED

event name: address_updated
usage: This means this customer has updated his address
address events' data:

attached smarty tags for the address events:

[
  'id',
  'type',
  'first_name',
  'last_name',
  'line1',
  'line2',
  'city',
  'state',
  'country',
  'postal_code',
  'created_at',
  'updated_at'
]

SOURCE EXPIRING

event name: source_expiring
usage: This means the customer's payment source or his card will expire at the end of the month.

SOURCE CANCELED

event name: source_canceled
usage: This means the customer's payment source or his card is canceled.

[
  'exp_month',
  'exp_year',
  'address_zip_check',
  'brand',
  'country',
  'cvc_check',
  'funding',
  'last4',
  'name',
  'address_line1_check',
  'dynamic_last4',
]