Actions

In the Rebilly rules engine, an action is an operation that executes when an event occurs. This topic describes all action types and how to configure them. For a list of actions that are available for each event type, see Event types.

Add NSF fee

Adds a Non-Sufficient Funds (NSF) fee when a response is received from the NSF response received event.

Use this action to add an NSF fee for insufficient funds.

Associated events

This action is available for the NSF response received event.

Configure an Add NSF fee action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the NSF response received event.
  2. Select the Add NSF fee action.
  3. In the Add NSF fee action, enter the fee amount and select the related product ID.

Add risk score

Adds a risk score to a transaction.

A common use case for this event is to increase the risk score for suspicious transactions. For example, if a transaction has a billing address in a country which is considered to be high-risk for online fraud. A high-risk score can indicate that the transaction needs manual review by a risk-agent. Each transaction has a numeric risk score attribute. Setting a negative value decreases the risk score. For more information, see Risk scoring.

Associated events

This action is available for the Transaction processed and Transaction process requested events. It is also associated with the Risk score changed event.

Configure an Add risk score action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Transaction processed , Transaction process requested , or Risk score changed event.
  2. Select the Add risk score action action.
  3. In the Add risk score action, enter a risk score value.
    A negative number decreases the risk, a positive number increases the risk.

View a transaction's risk score

  1. In the left navigation bar, click Data tables icon .
  2. Click Payments , then click Sales .
  3. Locate the transaction and click the transaction ID. The transaction risk score is displayed in the Risk Analysis section.

Adjust ready to pay

Controls which payment methods are displayed when a customer is ready to make a payment. Use the filters to control which payment methods are displayed or the order in which they are displayed, for customer segments based on tags, geography, and custom fields.

Associated events

This action is available for the Ready to pay requested event.

Configure an Adjust ready to pay action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Ready to pay requested event.
  2. Select the Adjust ready to pay action.
  3. In the Adjust ready to pay action:
    1. Based on your active payment gateways, add payment methods and drag items to set the display order.
    2. Optionally, to prioritize payment methods that are associated with a customer's active payment instruments, select the Prioritize active payment instruments checkbox. At the point of sale, these methods are displayed on top of the list of available payment methods.

Blocklist actions

Adds a specified attribute and value, such as: customer ID, IP address, or payment card, to a blocklist for a period of time. This period of time is referred to as a Time To Live (TTL), and is measured in seconds. The use of a blocklisted value is prohibited until the TTL is expired. For more information, see Blocklists.

A common use case for this action is to block a payment card, or a customer, from making further transactions while a transaction is disputed.

Associated events

This action is available for the Risk score changed, Transaction processed, and Dispute created events.

Configure a Blocklist action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Risk score changed or Dispute created event.
  2. Select the Blocklist action.
  3. In the Blocklist action, select a blocklist type and the duration of the blocklist.
    To set the blocklist to never expire, select the Never expires checkbox.

Blocklist types

  • Blocklist customer ID.
  • Blocklist email.
  • Blocklist fingerprint (unique device fingerprint).
  • Blocklist IP address.
  • Blocklist payment card.

View active blocklists

  1. In the left navigation bar, click automations icon Automations , then click Rules engine .
  2. Depending on where the related action is located, click Core events or Billing events .
  3. In the event list, select the related event.
  4. Click Ruleset .
  5. Click a blocklist to expand and get more information.

Alternatively:

  1. In the left navigation bar, click automations icon Automations .
  2. Click Blocklists .

Cancel scheduled payments

Cancels all scheduled payments and void outstanding invoices related to a canceled subscription.

Associated events

This action is available for the Subscription canceled event.

Configure a Cancel scheduled payments action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Subscription canceled event.
  2. Select the Cancel scheduled payments action.

Churn subscription

Ends a subscription when a renewal invoice payment is canceled.

Associated events

This action is available for the Renewal invoice payment canceled event.

Configure a Churn subscription action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Renewal invoice payment canceled event.
  2. Select the Churn subscription action.

Create a Taxjar transaction

Sends transaction related data to your TaxJar account, using the Rebilly TaxJar integration.

Associated events

This action is available for the Invoice paid and the Invoice refunded events.

Configure a Create a Taxjar transaction action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Invoice paid or Invoice refunded event.
  2. Select the Create a Taxjar transaction action

Display a message

Displays a message before purchase confirmation, which is based on the customer's language.

Associated events

This action is available for the Gateway account requested event.

Configure a Display a message action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Gateway account requested event.
  2. Select the Display a message action.

Display other choices

Displays various choices at the purchase screen, based on the customer's language.

Associated events

This action is available for the Gateway account requested event.

Configure a Display other choices action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Gateway account requested event.
  2. Select the Display other choices action..

Decline a transaction

Declines a transaction and stops it from being processed.

A common use case for this action is to limit the maximum amount in a transaction, where it is not processed if the amount is greater than a set value. In this case, the action stops large transactions that may incur additional fees, or avoids transactions amounts that are too small to process.

Associated events

This action is available for the Transaction process requested event.

Configure a Decline a transaction action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Transaction process requested event.
  2. Select the Decline a transaction action.
  3. In the Decline a transaction action, configure a maximum or minimum transaction amount: In the Conditions section, clear the Match all cases checkbox, in the Select filter dropdown select Transaction > amount , configure the condition, then click Add filter .

Guess payment card expiration

Instructs Rebilly to guess the new expiration date of an expired payment card.

This action makes up to 3 attempts to guess the new expiration date. For each guess, the action attempts a $1 authorization. On a successful authorization, the customer's payment card is updated to use that expiration date and the $1 authorization is voided.

Associated events

This action is available for the Payment card expired event.

Configure a Guess payment card expiration action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Payment card expired event.
  2. Select the Guess payment card expiration action.

Perform Experian check

Performs an identity check using the Rebilly Experian integration.

Associated events

This action is available for the Transaction process requested event.

Configure a Perform Experian check action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Transaction process requested event.
  2. Select the Perform Experian check action.

Pick gateway account

Dynamically routes transactions between payment gateways, based on real-time data and selected parameters.

When a customer first attempts a transaction, a gateway account is requested. Rebilly can assign a gateway account based on gateway account weight or gateway acquirer weight. The weight specifies priority. To configure payment routing you must have more than one gateway account connected to Rebilly.

Associated events

This action is available for the Gateway account requested event.

Configure a Pick gateway account action

To configure a Pick gateway account action, see Enable gateway routing.


Offer a purchase bump

Presents the customer with purchase discounts at the payment screen. Use this action to offer purchase bonuses and deals to the customer. Purchase bump details can be configured to display in the customer's native language.

Associated events

This action is available for the Transaction process requested event.

Configure an Offer a purchase bump action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Transaction process requested event.
  2. Select the Offer a purchase bump action.
  3. In the Offer a purchase bump action:
    • To create two or more bump options, and send both to your audience based on a specific weighting:
      1. In the Split test section, click Create split test .
      2. Click Add version and specify the weight distribution.
        When you decide which bump option is the most effective, click Pick a winner to remove the other options.
    • To describe the purchase bump at the payment screen:
      1. In the HTML content field, compose your content.
      2. Click Add placeholders , to add dynamic event based content.

Request KYC

Displays a Know Your Customer (KYC) form to the customer. The KYC form requests documentation that is used to verify the customer's identity.

Associated events

This action is available for the Gateway account requested event.

Configure a Request KYC action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Gateway account requested event.
  2. Select the Request KYC action.

Reset reminder

Resets the Schedule reminder action.

Associated events

This action is available for the Payment card expiration reminder, Payment card expired, Invoice past due, and Invoice past due reminder events.

Configure a Reset reminder action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Payment card expiration reminder , Payment card expired , Invoice past due , or Invoice past due reminder event.
  2. Select the Reset reminder action.

Remove reminder

Erases a scheduled reminder.

Associated events

This action is available for the Payment card expiration reminder, Payment card expired, Subscription renewal reminder, Subscription renewed, Invoice past due, and Invoice past due reminder events.

Configure a Remove reminder action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Payment card expiration reminder , Payment card expired , Subscription renewal reminder , Subscription renewed , Invoice past due , or Invoice past due reminder event.
  2. Select the Remove reminder action.

Schedule payment

Schedules a payment for a renewed subscription.

Associated events

This action is available for the Renewal invoice issued and Subscription renewed events.

Configure a Schedule payment action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Renewal invoice issued or Subscription renewed event.
  2. Select the Schedule payment action.

Schedule payment retry

Schedules multiple payment retries for when a payment for a subscription fails. Retries can be scheduled by: second, minute, hour, day, month, or year. The payment amount can be adjusted on each retry — making the payment partial, or applying a discount. When a final retry attempt fails, this action can be set to cancel the subscription and the abandon invoice.

Associated events

This action is available for the Renewal invoice payment declined event.

Configure a Schedule payment retry action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select the Renewal invoice payment declined event.
  2. Select the Schedule payment retry action.
  3. In the Retry attempts action:
    1. Click Add attempt , then enter the retry schedule and payment adjustment type.
    2. To ensure that the recurring payment does not occur within the retry schedule, in the After each attempt section, select the Push renewal time forward checkbox.
    3. To accommodate the scenario where all retry attempts fail, in the After the last failed attempt section, select one or both the Cancel subscription and Abandon invoice checkboxes.
    4. To override a retry that is in process, in the Override existing retry section, select the Override existing retry checkbox.
    5. To use backup payment instruments when payment with a primary payment instrument fails, select the Try backups checkbox.

Send email

Notifies a customer when an event occurs. For example, to notify a customer that their subscription is canceled. You can send multiple emails with different content.

Associated events

This action is available for all events.

Configure a Send email action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select any event. This action is available for all events.
  2. Select the Send email action.
  3. In the Send email action:
    • To send the email from your own address, in the From field, select your address. If your address is not listed, click Add From address .
    • To create two or more emails, and send both to your audience based on a specific weighting:
      1. In the Split test section, click Create split test .
      2. Click Add version and specify the weight distribution.
      3. When you decide which email is the most efficient, click Pick a winner to remove the other emails.
    • To add email content:
      1. In the Email content field, compose your email.
      2. Click Add placeholders , to add dynamic content event based content. For example, a placeholder to fetch the email address of a customer is ##{{subscription.customer.email}} . The email can be in plain text or HTML. For more information, see Placeholders .
    • To attach an invoice, if you are using an invoice related event: Select the Attach invoice checkbox.

View active email notifications

  1. In the left navigation bar, click automation icon Automations , then click Notifications .
  2. In the Customer notification section, select the Show only events with emails radio button. All events with that involve an email action are displayed.

Add new email actions from the Notifications screen

  1. In the left navigation bar, click automation icon Automations , then click Notifications .
  2. In the Customer notification section, select the Show all core events or the Show all billing events radio button.
  3. Select an event, click Add notification

Schedule reminder

Schedules a reminder.

A common use case for this action is to schedule a reminder when an invoice is past due.

Associated events

This action is available for the following events:

Configure a Schedule reminder action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select one of the following events:
    • Invoice issued .
    • Invoice past due .
    • Invoice past due reminder .
    • Payment card created .
    • Payment card expired .
    • Payment card expiration reminder .
    • Subscription activated .
    • Subscription renewal reminder .
    • Subscription trial converted .
    • Subscription trial end reminder .
  2. Select the Schedule reminder action.

Show descriptor disclaimer

Displays a disclaimer message at the point of sale. Use this message to display important information to the customer before they complete a purchase.

Associated events

This action is available for the Gateway account requested event.

Configure a Show descriptor disclaimer action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select Gateway account requested event.
  2. Select the Show descriptor disclaimer action.

Stop subscriptions

Cancels active subscriptions based on transaction outcome. This action cancels both active subscriptions and renewals immediately after the event is executed.

Associated events

This action is available for the Transaction Processed event.

Configure a Stop subscriptions action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select Transaction Processed event.
  2. Select the Stop subscriptions action.

Tag or untag a customer

Tags or untag a customer based on the occurrence or a specific event.

Use this to add emphasis to specific customers, so that you can filter and find them in Data tables.

Associated events

This action is available for all events.

Configure a Tag or untag a customer action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select any event. This action is available for all events.
  2. Select the Tag or untag a customer action.

Trigger a webhook

A webhook is an HTTP callback: an HTTP request that provides other applications real-time information when an event occurs.

A common use case for this action is to send event information to third-party services, or execute more complex action sequences.

Use GET or POST parameters in the request body and use placeholders that are related to the event that is triggered. For example, {{subscription.customer.email}} fetches a customer’s email for a subscription-related event.

Associated events

This action is available for all events.

Configure a Trigger a webhook action

Create a rule or bind or Create a draft ruleset. During the configuration:

  1. Select any event. This action is available for all events.
  2. Select the Trigger a webhook action.