Stripe Python Library
The Stripe Python library provides convenient access to the Stripe API from applications written in the Python language. It includes a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which makes it compatible with a wide range of versions of the Stripe API.
See the Python API docs.
You don't need this source code unless you want to modify the package. If you just want to use the package, just run:
pip install --upgrade stripe
Install from source with:
python setup.py install
- Python 2.7+ or Python 3.4+ (PyPy supported)
The library needs to be configured with your account's secret key which is
available in your Stripe Dashboard. Set
stripe.api_key to its
import stripe stripe.api_key = "sk_test_..." # list customers customers = stripe.Customer.list() # print the first customer's email print(customers.data.email) # retrieve specific Customer customer = stripe.Customer.retrieve("cus_123456789") # print that customer's email print(customer.email)
Unsuccessful requests raise exceptions. The class of the exception will reflect the sort of error that occurred. Please see the Api Reference for a description of the error classes you should handle, and for information on how to inspect these errors.
import stripe # list customers stripe.Customer.list( api_key="sk_test_...", stripe_account="acct_...", stripe_version="2019-02-19" ) # retrieve single customer stripe.Customer.retrieve( "cus_123456789", api_key="sk_test_...", stripe_account="acct_...", stripe_version="2019-02-19" )
Configuring a Client
The library can be configured to use
client = stripe.http_client.UrlFetchClient() client = stripe.http_client.RequestsClient() client = stripe.http_client.PycurlClient() client = stripe.http_client.Urllib2Client() stripe.default_http_client = client
Without a configured client, by default the library will attempt to load
libraries in the order above (i.e.
urlfetch is preferred with
as a last resort). We usually recommend that people use
Configuring a Proxy
A proxy can be configured with
stripe.proxy = "https://user:firstname.lastname@example.org:1234"
Configuring Automatic Retries
You can enable automatic retries on requests that fail due to a transient problem by configuring the maximum number of retries:
stripe.max_network_retries = 2
Various errors can trigger a retry, like a connection error or a timeout, and
also certain API responses like HTTP status
Idempotency keys are automatically generated and added to requests, when not given, to guarantee that retries are safe.
The library can be configured to emit logging that will give you better insight
into what it's doing. The
info logging level is usually most appropriate for
production use, but
debug is also available for more verbosity.
There are a few options for enabling it:
Set the environment variable
STRIPE_LOGto the value
$ export STRIPE_LOG=debug
import stripe stripe.log = 'debug'
Enable it through Python's logging module:
import logging logging.basicConfig() logging.getLogger('stripe').setLevel(logging.DEBUG)
Writing a Plugin
If you're writing a plugin that uses the library, we'd appreciate it if you
stripe.set_app_info("MyAwesomePlugin", version="1.2.34", url="https://myawesomeplugin.info")
This information is passed along when the library makes calls to the Stripe API.
Request latency telemetry
By default, the library sends request latency telemetry to Stripe. These numbers help Stripe improve the overall latency of its API for all users.
You can disable this behavior if you prefer:
stripe.enable_telemetry = False
go get -u github.com/stripe/stripe-mock stripe-mock
Run the following command to set up the development virtualenv:
Run all tests on all supported Python versions:
Run all tests for a specific Python version (modify
-e according to your Python target):
TOX_ARGS="-e py37" make test
Run all tests in a single file:
TOX_ARGS="-e py37 -- tests/api_resources/abstract/test_updateable_api_resource.py" make test
Run a single test suite:
TOX_ARGS="-e py37 -- tests/api_resources/abstract/test_updateable_api_resource.py::TestUpdateableAPIResource" make test
Run a single test:
TOX_ARGS="-e py37 -- tests/api_resources/abstract/test_updateable_api_resource.py::TestUpdateableAPIResource::test_save" make test
Run the linter with:
The library uses Black for code formatting. Code must be formatted with Black before PRs are submitted, otherwise CI will fail. Run the formatter with: