Last updated

Actions

Actions are tasks that execute when an event with a configured rule or bind occurs. This topic describes all action types and how to configure them.

To configure event based email notifications, see Email notifications.

Terms

  • Event: An event is a preconfigured occurrence. For example, when a customer new customer is created, the 'customer created' event is triggered.
  • Rules and binds: There are two methods of creating automations in Rebilly:
    • Rules: Can be configured to stop subsequent rules in the event list from being executed.
    • Binds: Can be configured to always execute, regardless of rule-based events. Use this automation type when you want to ensure an automation always executes when an event occurs.
  • Ruleset: Each event maintains a list of automations that are to be executed under specified conditions when the event occurs. These lists of automations are called rulesets. Rulesets are executed in the order they are listed on the event.
  • Draft rulesets: Provide a means of testing, and comparing changes with the active ruleset before publishing.
  • Actions: Tasks that execute when an event with a configured rule or bind occurs.

Abandon scheduled payments

Abandons scheduled payments for an order that exceeds the configured delinquency period. For information on delinquency periods and how to configure them, see Delinquency periods.

Associated events

This action is available for the Order delinquency reached event.

Create an 'Abandon scheduled payments' action

Create a rule or bind that includes an 'Abandon scheduled payments' action

This process creates a rule or bind that is added to the ruleset of the Order delinquency reached event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select Order delinquency reached.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Abandon scheduled payments. / This action will abandon scheduled payments for an order that exceeds the configured delinquency period. To configure the delinquency period, see Delinquency periods.

  8. At the bottom of the page, press Save rule or Save bind.

Create a draft ruleset that includes an 'Abandon scheduled payments' action

This process creates a draft ruleset for the Order delinquency reached event. The draft ruleset includes a rule or bind for an 'Abandon scheduled payments' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select Order delinquency reached.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Abandon scheduled payments. / This action will abandon scheduled payments for an order that exceeds the configured delinquency period. To configure the delinquency period, see Delinquency periods.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create an 'Add NSF fee' action

Create a rule or bind that includes an 'Add NSF fee' action

This process creates a rule or bind that is added to the ruleset of the NSF response received event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select NSF response received.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Add NSF fee action.

  8. In the Amount field, enter the Non-Sufficient Funds (NSF) fee. When an account does not have enough funds, this fee is charged.

  9. In the Product ID field, select the related product ID.

  10. Press Save rule or Save bind.

Create a draft ruleset that includes the 'Add NSF fee' action

This process creates a draft ruleset for the NSF response received event. The ruleset includes a rule or bind for an 'Add NSF fee' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select NSF response received.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Add NSF fee action.

  11. In the Amount field, enter the Non-Sufficient Funds (NSF) fee. When an account does not have enough funds, this fee is charged.

  12. In the Product ID field, select the related product ID.

  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create an 'Adjust ready to pay' action

Create a rule or bind that includes an 'Adjust ready to pay' action

This process creates a rule or bind that is added to the ruleset of the Ready to pay requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select Ready to pay requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Adjust ready to pay.

  8. Based on your active payment gateways, add payment methods and drag items to set the display order.

  9. Optionally, to prioritize payment methods that are associated with a customer's active payment instruments, select the Prioritize active payment instruments checkbox.

  10. At the point of sale, these methods are displayed on top of the list of available payment methods.

  11. Press Save rule or Save bind.

Create a draft ruleset that includes an 'Adjust ready to pay' action

This process creates a draft ruleset for the Ready to pay requested event. The ruleset includes a rule or bind for an 'Adjust ready to pay' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Ready to pay requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Adjust ready to pay.

  11. Based on your active payment gateways, add payment methods and drag items to set the display order.

  12. 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.

  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

Adjust ready to payout

Controls which payment methods are displayed when a customer requests a payout. 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.

To configure how a gateway manages payout requests, set the ready to payout instruction in gateway account settings. For more information, see the configure how the gateway manages payout requests step when setting up a gateway account.

Associated events

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

Create an 'Adjust ready to payout' action

Create a rule or bind that includes an 'Adjust ready to payout' action

This process creates a rule or bind that is added to the ruleset of the Ready to payout requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then press Ready to payout requested

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Adjust ready to payout.

  8. Based on your active payment gateways, add payment methods and drag items to set the display order.

  9. 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 pay out, these methods are displayed on top of the list of available payment methods.

  10. Press Save rule or Save bind.

Create a draft ruleset that includes an 'Adjust ready to payout' action

This process creates a draft ruleset for the Ready to payout requested event. The ruleset includes a rule or bind for an 'Adjust ready to payout' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then press Ready to payout requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Adjust ready to payout.

  11. Based on your active payment gateways, add payment methods and drag items to set the display order.

  12. 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 pay out, these methods are displayed on top of the list of available payment methods.

  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Blocklist' action

Create a rule or bind that includes a 'Blocklist' action

This process creates a rule or bind that is added to a ruleset associated with one of the following events: Risk score changed, Transaction processed, or Dispute created.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select one of the following events: Risk score changed, Transaction processed, or Dispute created.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Blocklist action.

  8. In the Blocklist type dropdown, select the type of blocklist. For more information, see Blocklist types.

  9. Optionally, to specify that the blocklist to never expire, select the Never expires checkbox.

  10. In the Duration field, specify the duration of the blocklist in seconds.

  11. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Blocklist' action

This process creates a draft ruleset one for the following events: Risk score changed, Transaction processed, or Dispute created events. The ruleset includes a rule or bind for a 'Blocklist' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select one of the following events: Risk score changed, Transaction processed, or Dispute created.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Blocklist action.

  11. In the Blocklist type dropdown, select the type of blocklist. For more information, see Blocklist types.

  12. Optionally, to specify that the blocklist to never expire, select the Never expires checkbox.

  13. In the Duration field, specify the duration of the blocklist in seconds.

  14. Press Save rule or Save bind.

  15. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

Blocklist types

  • Blocklist customer ID.
  • Blocklist email.
  • Blocklist fingerprint (unique device fingerprint).

    A device fingerprint is a unique identifier for a device. It is generated from specific device characteristics, such as: operating system, browser, and IP address. Device fingerprints are used to identify devices and prevent fraud.

  • Blocklist IP address.
  • Blocklist payment card.

View active blocklists

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

Alternatively:

  1. In the left navigation bar, press Automations .
  2. In the Risk section, press 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.

Create a 'Cancel scheduled payments' action

Create a rule or bind that includes a 'Cancel scheduled payments' action

This process creates a rule or bind that is added to the ruleset of the Subscription canceled event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select Subscription canceled.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Cancel scheduled payments action.

  8. Optionally, to exclude invoices with services periods that have already started, select the checkbox.

  9. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Cancel scheduled payments' action

This process creates a draft ruleset for the Subscription canceled event. The ruleset includes a rule or bind for a 'Cancel scheduled payments' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select Subscription canceled.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Cancel scheduled payments action.

  11. Optionally, to exclude invoices with services periods that have already started, select the checkbox.

  12. Press Save rule or Save bind.

  13. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Churn subscription' action

Create a rule or bind that includes a 'Churn subscription' action

This process creates a rule or bind that is added to the ruleset of the Renewal invoice payment canceled event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select Renewal invoice payment canceled.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Churn subscription action.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Churn subscription' action

This process creates a draft ruleset for the Renewal invoice payment canceled. The ruleset includes a rule or bind for a 'Churn subscription' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select Renewal invoice payment canceled.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Churn subscription action.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Display a message' action

Create a rule or bind that includes a 'Display a message' action

This process creates a rule or bind that is added to the ruleset of the Gateway account requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select Gateway account requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Display a message action.

  8. In the HTML content field, enter a message.

  9. Optionally, to add more messages in different languages:

    1. Press Add language, the select a language and press Add language.
    2. In the HTML content field, press the language name, then enter a message.
  10. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Display a message' action

This process creates a draft ruleset for the Gateway account requested. The ruleset includes a rule or bind for a 'Display a message' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Gateway account requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Display a message action.

  11. In the HTML content field, enter a message.

  12. Optionally, to add more messages in different languages:

    1. Press Add language, the select a language and press Add language.
    2. In the HTML content field, press the language name, then enter a message.
  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Display other choices' action

Create a rule or bind that includes a 'Display other choices' action

This process creates a rule or bind that is added to the ruleset of the Gateway account requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select Gateway account requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Display other choices action.

  8. In the HTML content field, enter a message.

  9. Optionally, to display additional choices based on the user's detected language:

    1. Press Add language, the select a language and press Add language.
    2. In the HTML content field, press the language name, then enter a message.
  10. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Display other choices' action

This process creates a draft ruleset for the Gateway account requested. The ruleset includes a rule or bind for a 'Display other choices' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Gateway account requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Display other choices action.

  11. In the HTML content field, enter a message.

  12. Optionally, to display additional choices based on the user's detected language:

    1. Press Add language, the select a language and press Add language.
    2. In the HTML content field, press the language name, then enter a message.
  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Decline a transaction' action

Create a rule or bind that includes a 'Decline a transaction' action

This process creates a rule or bind that is added to the ruleset of the Transaction process requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then press Transaction process requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Specify conditions on when to decline a transaction

    To use the decline a transaction action, you must specify conditions that determine when the action is executed.

    Example: Decline a transaction if the amount is greater than $100
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select Transaction > amount.
    3. In the Operation dropdown, select a greater or equal to.
    4. In the Value field, enter 100.01.
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Decline a transaction.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Decline a transaction' action

This process creates a draft ruleset for the Transaction process requested. The ruleset includes a rule or bind for a 'Decline a transaction' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Transaction process requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Specify conditions on when to decline a transaction

    To use the decline a transaction action, you must specify conditions that determine when the action is executed.

    Example: Decline a transaction if the amount is greater than $100
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select Transaction > amount.
    3. In the Operation dropdown, select a greater or equal to.
    4. In the Value field, enter 100.01.
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Decline a transaction.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Guess payment card expiration' action

Create a rule or bind that includes a 'Guess payment card expiration' action

This process creates a rule or bind that is added to the ruleset of the Payment card expired event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select Payment card expired.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Payment card expired.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Guess payment card expiration' action

This process creates a draft ruleset for the Payment card expired. The ruleset includes a rule or bind for a 'Guess payment card expiration' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select Payment card expired.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Payment card expired.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

Perform Experian check

Performs an identity check using the Rebilly Experian integration.

Associated events

This action is available for the Transaction process requested event.

Create a 'Perform Experian check' action

Create a rule or bind that includes a 'Perform Experian check' action

This process creates a rule or bind that is added to the ruleset of the Transaction process requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select Transaction process requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Perform Experian check.

  8. In the Experian credential hash field, select an Experian credentials hash value.
    For more information, see Experian integration.

  9. In the Identity matches, Identity mismatches, and Result unknown dropdowns, select tags to apply based on the Experian check result.
    To create tags, see Create a tag.

  10. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Perform Experian check' action

This process creates a draft ruleset for the Transaction process requested. The ruleset includes a rule or bind for a 'Perform Experian check' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Transaction process requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Perform Experian check.

  11. In the Experian credential hash field, select an Experian credentials hash value.
    For more information, see Experian integration.

  12. In the Identity matches, Identity mismatches, and Result unknown dropdowns, select tags to apply based on the Experian check result.
    To create tags, see Create a tag.

  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Pick gateway account' action

To create a 'Pick gateway account' action, see Set up 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.

Create an 'Offer purchase bump' action

Create a rule or bind that includes a 'Offer purchase bump' action

This process creates a rule or bind that is added to the ruleset of the Transaction process requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then select Transaction process requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Offer a purchase bump action.

  8. Optionally, create a split test

    Use this process to create more than one bump option and display them to your audience based on a specific weighting, to determine which is most effective.

    1. In the Split test section, press Create split test.
    2. Press Add version and specify the weight distribution.
      When you decide which bump option is the most effective, press Select version to remove the other options.
  9. Configure bump offers:

    1. In the Offer ID field, enter the ID of the offer.
    2. In the Offer type field, describe the type of offer. For example, "Discount" or "Bonus".
    3. In the Bump amount field, enter the amount.
    4. Optionally, to add more than one offer, press + Add new offer.
      You can add multiple offers. For each offer, enter the offer ID, type, and amount.
    5. In the HTML content field, compose your content.
      1. Optionally, to add dynamic event based information to your content, press + Insert placeholders.
      2. Optionally, to add a language, press Add language, and enter a message. This message is displayed based on the customer's detected language.
  10. Press Save rule or Save bind.

Create a draft ruleset that includes an 'Offer purchase bump' action

This process creates a draft ruleset for the Transaction process requested. The ruleset includes a rule or bind for an 'Offer purchase bump' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then select Transaction process requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Offer a purchase bump action.

  11. Optionally, create a split test

    Use this process to create more than one bump option and display them to your audience based on a specific weighting, to determine which is most effective.

    1. In the Split test section, press Create split test.
    2. Press Add version and specify the weight distribution.
      When you decide which bump option is the most effective, press Select version to remove the other options.
  12. Configure bump offers:

    1. In the Offer ID field, enter the ID of the offer.
    2. In the Offer type field, describe the type of offer. For example, "Discount" or "Bonus".
    3. In the Bump amount field, enter the amount.
    4. Optionally, to add more than one offer, press + Add new offer.
      You can add multiple offers. For each offer, enter the offer ID, type, and amount.
    5. In the HTML content field, compose your content.
      1. Optionally, to add dynamic event based information to your content, press + Insert placeholders.
      2. Optionally, to add a language, press Add language, and enter a message. This message is displayed based on the customer's detected language.
  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Request KYC' action

To create a request KYC action, see Create an automated KYC document request


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.

Create a 'Reset reminder' action

Create a rule or bind for 'Reset reminder' action

This process creates a rule or bind that is added to a ruleset associated with one of the following events: Payment card expiration reminder, Payment card expired, Invoice past due, or Invoice past due reminder.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select one of the following events: Payment card expiration reminder, Payment card expired, Invoice past due, or Invoice past due reminder.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Reset reminder.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes 'Reset reminder' action

This process creates a draft ruleset for one of the following events: Payment card expiration reminder, Payment card expired, Invoice past due, or Invoice past due reminder. The draft ruleset includes a rule or bind for a 'Reset reminder' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select one of the following events: Payment card expiration reminder, Payment card expired, Invoice past due, or Invoice past due reminder.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Reset reminder.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Remove reminder' action

Create a rule or bind that includes a 'Remove reminder' action

Depending on which event you select, the created rule or bind is added to a ruleset that is associated with one of the following events: Payment card expiration reminder, Payment card expired, Subscription renewal reminder, Subscription renewed, Invoice past due, or Invoice past due reminder.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select one of the following events:

    • Payment card expiration reminder
    • Payment card expired
    • Subscription renewal reminder
    • Subscription renewed
    • Invoice past due
    • Invoice past due reminder
  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select Remove reminder.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Remove reminder' action

This process creates a draft ruleset for the following events: Payment card expiration reminder, Payment card expired, Subscription renewal reminder, Subscription renewed, Invoice past due, or Invoice past due reminder. The draft ruleset includes a rule or bind for a 'Remove reminder' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select one of the following events:

    • Payment card expiration reminder
    • Payment card expired
    • Subscription renewal reminder
    • Subscription renewed
    • Invoice past due
    • Invoice past due reminder
  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select Remove reminder.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

Schedule payment

Schedules a payment for a renewed subscription.

Associated events

This action is available for the Renewal invoice issued event.

Create a 'Schedule payment' action

Create a rule or bind that includes a 'Schedule payment' action

This process creates a rule or bind that is added to the ruleset of the Renewal invoice issued event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then press Renewal invoice issued.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then press Schedule payment.

  8. In the Schedule payment dropdown, select and define a payment schedule.

  9. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Schedule payment' action

This process creates a draft ruleset for the Renewal invoice issued. The ruleset includes a rule or bind for a 'Schedule payment' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then press Renewal invoice issued.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Schedule payment dropdown, select and define a payment schedule.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

Schedule invoice 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.

Create a 'Schedule invoice retry' action

Create a rule or bind that includes a 'Schedule invoice retry' action

This process creates a rule or bind for the Renewal invoice payment declined event that includes a 'Schedule invoice retry' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then select Renewal invoice payment declined.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. Configure the 'Schedule invoice retry' action
    1. In the Actions section, press Add action, then select the Schedule invoice retry action.

    2. In the Retry attempts section, press Add attempt.

      Retries are relative to the previous attempt. For example, to retry the payment 1 hour after the previous attempt, enter '1' in the input field and select Hours.

    3. Select from one of the following retry options:

      Retry after a certain amount of time Select this option to retry the payment after a certain amount of time.
      1. In the Schedule type section, select Retry after a certain amount of time.
      2. Specify the amount of time to wait before the retry attempt.
      Retry on a specific date Select this option to retry the payment on a specific date.
      1. In the Schedule type section, select Retry on a specific date.
      2. Specify the date, and optionally the time, of the retry attempt.
      Retry on a specific day Select this option to retry the payment on a specific day.
      1. In the Schedule type section, select Retry on a specific day.
      2. Specify the day, and optionally the time, of the retry attempt.
      Retry immediately Select this option to retry the payment immediately.
      1. In the Schedule type section, select Retry immediately.
      Retry intelligently Select this option to retry the payment based on historical BIN approval rates during a specific period of time.
      1. In the Schedule type section, select Retry on a specific day.
      2. Specify the time period that the retry attempt must occur in.
    4. In the Payment adjustment section, select one of the following options:

      • Full amount: Select this option to retry the full amount of the invoice.
      • Partial amount: Select this option to retry a partial amount of the invoice.
        1. Select Fixed to specify a fixed amount, or select Percentage to specify a percentage of the invoice amount.
        2. Enter the amount.
        3. To specify actions to take when a partial payment is approved, select one of the following:
          • Do nothing: Select this option to not take any action.
          • Discount the remaining amount due: Select this option to discount the amount paid from the remaining amount due.
    5. Optionally, to try to collect payment using the customer's backup payment instruments, select the Try backup payment instruments checkbox.

    6. 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.

    7. 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.

    8. To override a retry that is in process, in the Override existing retry section, select the Override existing retry checkbox.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Schedule invoice retry' action

This process creates a draft ruleset that includes a rule or bind for a 'Schedule invoice retry' action and is associated with the Renewal invoice payment declined event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then select Renewal invoice payment declined.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. Configure the 'Schedule invoice retry' action
    1. In the Actions section, press Add action, then select the Schedule invoice retry action.

    2. In the Retry attempts section, press Add attempt.

      Retries are relative to the previous attempt. For example, to retry the payment 1 hour after the previous attempt, enter '1' in the input field and select Hours.

    3. Select from one of the following retry options:

      Retry after a certain amount of time Select this option to retry the payment after a certain amount of time.
      1. In the Schedule type section, select Retry after a certain amount of time.
      2. Specify the amount of time to wait before the retry attempt.
      Retry on a specific date Select this option to retry the payment on a specific date.
      1. In the Schedule type section, select Retry on a specific date.
      2. Specify the date, and optionally the time, of the retry attempt.
      Retry on a specific day Select this option to retry the payment on a specific day.
      1. In the Schedule type section, select Retry on a specific day.
      2. Specify the day, and optionally the time, of the retry attempt.
      Retry immediately Select this option to retry the payment immediately.
      1. In the Schedule type section, select Retry immediately.
      Retry intelligently Select this option to retry the payment based on historical BIN approval rates during a specific period of time.
      1. In the Schedule type section, select Retry on a specific day.
      2. Specify the time period that the retry attempt must occur in.
    4. In the Payment adjustment section, select one of the following options:

      • Full amount: Select this option to retry the full amount of the invoice.
      • Partial amount: Select this option to retry a partial amount of the invoice.
        1. Select Fixed to specify a fixed amount, or select Percentage to specify a percentage of the invoice amount.
        2. Enter the amount.
        3. To specify actions to take when a partial payment is approved, select one of the following:
          • Do nothing: Select this option to not take any action.
          • Discount the remaining amount due: Select this option to discount the amount paid from the remaining amount due.
    5. Optionally, to try to collect payment using the customer's backup payment instruments, select the Try backup payment instruments checkbox.

    6. 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.

    7. 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.

    8. To override a retry that is in process, in the Override existing retry section, select the Override existing retry checkbox.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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:

Create a 'Schedule reminder' action

Create a rule or bind that includes a 'Schedule reminder' action

This process creates a rule or bind that is added to the ruleset of the one of the following events:

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Billing events, then 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
  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then press Schedule reminder.

  8. In the Schedule reminders section, under Schedule, select from the following to configure a reminder:

    • Certain amount of time: Schedules a reminder after a certain amount of time before or after the event.
    • On a specific date: Schedules a reminder on a specific date before or after the event.
    • On a specific day: Schedules a reminder on a specific day before or after the event.
  9. Optionally, to add more more reminders, press + Add reminder.

  10. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Schedule reminder' action

This process creates a draft ruleset for one of the following events:

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Billing events, then 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
  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then press Schedule reminder.

  11. In the Schedule reminders section, under Schedule, select from the following to configure a reminder:

    • Certain amount of time: Schedules a reminder after a certain amount of time before or after the event.
    • On a specific date: Schedules a reminder on a specific date before or after the event.
    • On a specific day: Schedules a reminder on a specific day before or after the event.
  12. Optionally, to add more more reminders, press + Add reminder.

  13. Press Save rule or Save bind.

  14. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Show descriptor disclaimer' action

Create a rule or bind that includes a 'Show descriptor disclaimer' action

This process creates a rule or bind that is added to the ruleset of the Gateway account requested event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events then press Gateway account requested.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Show descriptor disclaimer action.

  8. Specify the disclaimer text, button text, and return link text.

  9. Press Save rule or Save bind.

Create a draft ruleset that includes a 'Show descriptor disclaimer' action

This process creates a draft ruleset for the Gateway account requested. The ruleset includes a rule or bind for a 'Show descriptor disclaimer' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events then press Gateway account requested.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Show descriptor disclaimer action.

  11. Specify the disclaimer text, button text, and return link text.

  12. Press Save rule or Save bind.

  13. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.

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.

Create a 'Stop subscriptions' action

Create a rule or bind that includes a 'Stop subscriptions' action

This process creates a rule or bind that is added to the ruleset of the Transaction processed event.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, press Rules engine.

  3. Press Core events, then press Transaction processed.

  4. Press Rule set.

  5. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter.
        Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  6. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  7. In the Actions section, press Add action, then select the Stop subscriptions action.

  8. Press Save rule or Save bind.

Create a draft ruleset that includes 'Stop subscriptions' action

This process creates a draft ruleset for the Transaction processed. The ruleset includes a rule or bind for a 'Stop subscriptions' action.

  1. In the left navigation bar, press Automations .

  2. In the Rules engine section, Rules engine.

  3. Press Core events, then press Transaction processed.

  4. Press Draft rulesets, then press Create draft ruleset.

  5. Enter a name and description for the draft ruleset.

  6. Optionally, if you have existing rules on the event, and want to replace or edit them, select the Copy current ruleset checkbox.

  7. Press Save ruleset.

  8. Select from the following:

    • Create an automation that can stop all subsequent rules in the event list from being processed
      1. In the top left of the page, press Rules.
      2. Press Create rule.
      3. In the Rule name field, enter a name for your rule.
      4. In the Labels field, enter a value and press enter. Use labels to categorize and filter your rules and binds.
      5. Optionally, to specify that when this rule occurs, the rules engine stops subsequent rules in the event list from being processed, select the Stop further processing checkbox.
    • Create an automation that always executes regardless of rule based events
      1. In the top left of the page, press Binds.
      2. Press Create bind.
      3. In the Bind name field, enter a name for your bind.
  9. Optionally, specify conditions for when the action must trigger
    1. In the Conditions section, clear the No conditions checkbox.
    2. In the Filter dropdown, select a filter.
    3. In the Operation dropdown, select a condition.
      • To use data that is shared by other rules, or to compare against a list of data: select is in list or any other list filter type, then in the next field select the related list. For more information, see Create a value list.
      • To ensure that a specific field is empty, or not empty: select is empty or any other empty filter type. For more information, see Empty criteria.
    4. In the Value field, enter or select values.
    5. Press Add filter.
  10. In the Actions section, press Add action, then select the Stop subscriptions action.

  11. Press Save rule or Save bind.

  12. Optionally, to publish your ruleset from draft to live:

    1. In the right of the page, press , and select Publish.
      If you have existing rules or binds on the event, the differences are displayed.
    2. Press Publish. If you have existing rules or binds on the event, the differences are displayed.
    3. Press Publish.