Ready to get started?

Learn more about the CData Python Connector for Stripe or download a free trial:

Download Now

Use SQLAlchemy ORMs to Access Stripe Data in Python

The CData Python Connector for Stripe enables you to create Python applications and scripts that use SQLAlchemy Object-Relational Mappings of Stripe data.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems effectively. With the CData Python Connector for Stripe and the SQLAlchemy toolkit, you can build Stripe-connected Python applications and scripts. This article shows how to use SQLAlchemy to connect to Stripe data to query, update, delete, and insert Stripe data.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live Stripe data in Python. When you issue complex SQL queries from Stripe, the CData Connector pushes supported SQL operations, like filters and aggregations, directly to Stripe and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to Stripe Data

Connecting to Stripe data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

Use the OAuth authentication standard to connect to Stripe. To authenticate using OAuth, you will need to register an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Follow the procedure below to install SQLAlchemy and start accessing Stripe through Python objects.

Install Required Modules

Use the pip utility to install the SQLAlchemy toolkit:

pip install sqlalchemy

Be sure to import the module with the following:

import sqlalchemy

Model Stripe Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with Stripe data.

engine = create_engine("stripe///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Declare a Mapping Class for Stripe Data

After establishing the connection, declare a mapping class for the table you wish to model in the ORM (in this article, we will model the Customers table). Use the sqlalchemy.ext.declarative.declarative_base function and create a new class with some or all of the fields (columns) defined.

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	Email = Column(String,primary_key=True)
	Discount = Column(String)
	...

Query Stripe Data

With the mapping class prepared, you can use a session object to query the data source. After binding the Engine to the session, provide the mapping class to the session query method.

Using the query Method

engine = create_engine("stripe///?OAuthClientId=MyOAuthClientId&OAuthClientSecret=MyOAuthClientSecret&CallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(Delinquent="False"):
	print("Email: ", instance.Email)
	print("Discount: ", instance.Discount)
	print("---------")

Alternatively, you can use the execute method with the appropriate table object. The code below works with an active session.

Using the execute Method

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.Delinquent == "False")):
	print("Email: ", instance.Email)
	print("Discount: ", instance.Discount)
	print("---------")

For examples of more complex querying, including JOINs, aggregations, limits, and more, refer to the Help documentation for the extension.

Insert Stripe Data

To insert Stripe data, define an instance of the mapped class and add it to the active session. Call the commit function on the session to push all added instances to Stripe.

new_rec = Customers(Email="placeholder", Delinquent="False")
session.add(new_rec)
session.commit()

Update Stripe Data

To update Stripe data, fetch the desired record(s) with a filter query. Then, modify the values of the fields and call the commit function on the session to push the modified record to Stripe.

updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Delinquent = "False"
session.commit()

Delete Stripe Data

To delete Stripe data, fetch the desired record(s) with a filter query. Then delete the record with the active session and call the commit function on the session to perform the delete operation on the provided recoreds (rows).

deleted_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

Free Trial & More Information

Download a free, 30-day trial of the Stripe Python Connector to start building Python apps and scripts with connectivity to Stripe data. Reach out to our Support Team if you have any questions.