Stripe Connector for UiPath : List all subscriptions via SQL

Integrate UiPath and Stripe
Integrate UiPath and Stripe

Learn how to list all subscriptions using the Stripe Connector for UiPath. This connector enables you to read and write Stripe data effortlessly. Manage customers, products, subscriptions, and invoices — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Stripe ODBC Driver

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
    • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
  4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Stripe" from the list of Popular Connectors. If "Stripe" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

    StripeDSN
    Stripe
    ODBC DSN Template Selection
  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

    Stripe authentication
    1. Login into your Stripe account
    2. Go to https://dashboard.stripe.com/apikeys.
    3. Then create a Secret key.
    4. In the parameter 'Token' fill in newly created key.
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Stripe [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    StripeDSN
    Stripe
    Stripe [Http]
    https://api.stripe.com/v1
    Required Parameters
    Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  6. Then go to Preview tab to start building a SQL query.

  7. Once you do that, proceed by opening Query Builder:

    ZappySys API Driver - Stripe
    Read and write Stripe data effortlessly. Manage customers, products, subscriptions, and invoices — almost no coding required.
    StripeDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Then simply select the List All Subscriptions endpoint (action).

  9. Continue by configuring the Required parameters. You can also set optional parameters too.

  10. Move on by hitting Preview Data button to preview the results.

  11. If you see the results you need, simply copy the generated query:

    List All Subscriptions
    Advanced Properties
    Next Link/Cursor Expression $.data[-1:].id
    Stop Indicator Value false
    Stop Indicator Attribute $.has_more
    Suffix for Next URL starting_after=<%nextlink%>
    SELECT * FROM Subscriptions
    Query Builder
  12. Click OK to use built SQL query and close the Query Builder.

  13. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in UiPath:

    ZappySys API Driver - Stripe
    Read and write Stripe data effortlessly. Manage customers, products, subscriptions, and invoices — almost no coding required.
    StripeDSN
    SELECT * FROM Subscriptions
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Stripe API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Stripe servers).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Stripe SQL query examples

Use these SQL queries in your UiPath data source:

Get Subscriptions

SELECT * FROM Subscriptions

get_subscriptions endpoint belongs to Subscriptions table(s), and can therefore be used via those table(s).

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table
  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"
    ZappySys Driver - Execute Custom Virtual Table Query

List all subscriptions in UiPath via SQL view

  1. Open UiPath Studio.

  2. Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).

  3. In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:

    Choosing UiPath Studio profile

    Simply select UiPath Studio option:

    Choosing UiPath Studio profile
  4. Start by creating a new project based on UiPath Process template:

    Creating new process in UiPath Studio to import ODBC data
  5. Add Run Query activity in Main Sequence box:

    Adding ODBC data source in UiPath Studio
  6. Click Configure Connection... button to create an ODBC connection:

    Configuring ODBC data source in UiPath in Run Query activity
  7. Continue by clicking Connection Wizard:

    Using connection wizard to setup ODBC source in UiPath Studio
  8. When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:

    StripeDSN
    StripeDSN
    Choosing ODBC DSN in UiPath Studio connection wizard
    You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
  9. Once you do that, it's time to configure a SQL query:

    Inputting SQL query for ODBC data source in UiPath Studio
    Make sure, you enclose the query in double quotes!
  10. Proceed by adding a Write CSV activity after Run Query:

    Adding Write CSV activity to write ODBC data in UiPath
    In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
  11. Once you do that, configure the added Write CSV, this will write Stripe data to a CSV file:

    Configuring Write CSV activity to write ODBC data in UiPath
  12. It's time for fun! Which means it's time for debugging! Just run the package locally to debug:

    Running UiPath process package to get ODBC data
  13. Finally, ensure there are no execution errors!

    Successful UiPath package debugging

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    
    ZappySys Driver - Create Custom Stored Procedure
  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';
    ZappySys Driver - Execute Custom Stored Procedure

Conclusion

And there you have it — a complete guide on how to list all subscriptions in UiPath without writing complex code. All of this was powered by Stripe ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

More actions supported by Stripe Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Stripe operations directly in UiPath, so you can skip the trial and error. Find your next step-by-step guide below:

More Stripe integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications