Set up the Paid Out of Band workflow
Learn how to configure the Paid Out of Band workflow in the Stripe Connector for NetSuite (SCN).
Warning
If you’re migrating from SuiteSync to the Stripe Connector for NetSuite, use the migration instructions.
The Stripe Connector for NetSuite supports the Paid Out of Band workflow. When you use the Stripe Connector Add-ons bundle ID 502910, the bundle’s native search and SuiteScript search for NetSuite invoices that were created as copies of Stripe invoices and paid outside of Stripe. The bundle uses the Stripe API to mark the invoice as Paid Out of Band.
Configure the Paid Out-of-Band script deployment
Installing the Add-ons bundle automatically creates a Stripe Custom Center tab in the colored bar on any NetSuite page. If you don’t see it, click the overflow menu (), which might also be hidden behind floating NetSuite elements.
- Hover over the Stripe tab in the colored bar on any NetSuite page.
- Go to Stripe > Add-ons > Manage Add-ons.
- On the subtabs bar, click Stripe Add-ons.
- On either the Inactive or Active subtab, locate Paid Out of Band.
- In the Paid Out of Band row, click Show More and read the technical feature description. When finished, close the window. The saved search for this script deployment isn’t configurable as with other Add-ons features. The search criteria is hardcoded into the script because it won’t change.
- In the Paid Out of Band row, click View.
- On the Script Deployment page, click Edit.
- Configure the Schedule subtab as needed. The script can run as frequently as every 15 minutes, daily. To use this option, you must also configure the
Start Timeto 12:00 AM (00:00). If you configure a different time, the script only runs every 15 minutes starting at that time, until the end of the specific day at 11:45 PM (23:45). You can also set the schedule to Single Event, which you can use for testing or manually running one-time batches. - On the Parameters subtab, set the
Effective Dateto the current date if you want to deploy the script today, or a different date if applicable. - Set the
Stripe Accountif you want to use one Stripe account when the script deployment runs. Otherwise, you can leave this blank. You see this dropdown on the following records: NetSuite account, Script Deployment page, subsidiary records, customer records, and transaction records. Select the record type in the hierarchy to associate with the Stripe account. If needed, you can edit the other record to configure the Stripe account. Note The dropdown lists all the available Stripe account custom records that you created during the Stripe Connector Add-ons bundle installation. You can create additional Stripe account records in a separate browser tab. - Click Save if you don’t want to deploy the script now. Otherwise, continue to the next step.
Deploy the script
- Confirm your deployment timing:
- In a NetSuite sandbox, you can deploy the script on a schedule or as a single event.
- In a NetSuite production environment, you must carefully time the script deployment to prevent unintended behavior. This step in the process is the final trigger for the workflow to function.
- On the Script Deployment page, configure the following: Note If you’re deploying to a NetSuite production environment, deselect the Test Mode checkbox.
- Set the Status to Testing or Scheduled .
- Select the Deployed checkbox when you want the deployment to be live.
- Click Save.
Validate the script functionality
- Confirm that at least one record meets the script’s native search criteria, as outlined in the previous window (the Show More window). If you’re in a test environment, you can create an automated test:
- Create a test Stripe invoice using a test customer and test products.
- Make sure the SCN App creates a NetSuite copy of the invoice in an Open state.
- Manually pay the NetSuite invoice by creating a customer payment that represents a payment accepted outside of Stripe (for example, a paper check).
- Confirm the NetSuite invoice status has changed to Paid in Full .
- Confirm the script is running:
- If you configured a schedule, the script now runs on that schedule.
- If you configured a single event, go to the Script Deployment page and click Edit . Select Save and Execute from the dropdown next to the Save button.
- After the script runs, go to the Stripe invoice in the Stripe Dashboard and confirm the status has changed to
Paid Out of Band.
See also
stripe trigger invoice.payment_succeeded