Stripe
Notes:
The Stripe connector is currently in feature preview and as such documentation for this feature is still work in progress
Overview
The Stripe connector can be used to load selected billing data from Stripe into xpna datasets.
Commonly loaded data includes:
- Customers
- Invoices
- Subscriptions
- Products
- Prices
Stripe Events are not available through this connector.
Connection Requirements
A Stripe restricted API key is required before the connection can be created.
The key must start with rk_test_ or rk_live_. Stripe secret keys that start with sk_ cannot be used.
The restricted key should be granted read-only access to the Stripe objects being loaded.
Note:
Stripe credentials are stored encrypted in xpna.
Use a restricted key with the smallest read-only permission set that supports the selected objects.
Source Items
Stripe objects are selected as source items in the configuration.
Each selected object can be mapped to a target such as a List dataset. Fields returned in sample data can be typed, renamed, imported, or excluded before the configuration is saved.
Nested Stripe values, such as metadata or nested payment details, are available as rich columns.
Refreshing Data
Data can be refreshed manually from the Connections page or by using the configured schedule.
If Stripe object fields are changed or new nested data is needed, sample data should be refreshed so the configuration can be reviewed.