Stripe Connector for Tableau
In this article you will learn how to integrate Stripe data in Tableau
without coding in just a few clicks (live / bi-directional connection to Stripe).
This connector support read/write operations for Stripe APIs.
Using Stripe Connector you will be able to connect, read, and write data from within Tableau. Follow the steps below to see how we would accomplish that.
Download
Documentation
The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.
|
Connect to Stripe in other apps
|
Create Data Source in ZappySys Data Gateway based on API Driver
-
Download and install ZappySys ODBC PowerPack.
-
Search for gateway in start menu and Open ZappySys Data Gateway:
-
Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
-
Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys API Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.
StripeDSN
-
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
-
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.
Steps to get Stripe Credentials : Stripe [Http]
- Login into your Stripe account
- Go to https://dashboard.stripe.com/apikeys.
- Then create a Secret key.
- In the parameter 'Token' fill in newly created key.
Fill in all required parameters and set optional parameters if needed:
StripeDSN
Stripe
Stripe [Http]
https://api.stripe.com/v1
-
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Read data in SQL Server from the ZappySys Data Gateway
-
To read the data in SQL Server the first thing you have to do is create a Linked Server. Go to SQL Server Management Studio and configure it in a similar way:
-
Then click on Security option and configure username we created in ZappySys Data Gateway in one of the previous steps:
-
Optional: Under the Server Options, Enable RPC and RPC Out and Disable Promotion of Distributed Transactions(MSDTC).
You need to enable RPC Out if you plan to use EXEC(...) AT [MY_LINKED_SERVER_NAME]
rather than OPENQUERY.
If don't enabled it, you will encounter the Server 'MY_LINKED_SERVER_NAME' is not configured for RPC
error.
Query Example:
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
If you plan to use 'INSERT INTO...EXEC(....) AT [MY_LINKED_SERVER_NAME]'
in that case you need to Disable Promotion of Distributed Transactions(MSDTC).
If don't disabled it, you will encounter the The operation could not be performed because OLE DB provider "SQLNCLI11" for linked server "MY_LINKED_SERVER_NAME" was unable to begin a distributed transaction.
error.
Query Example:
Insert Into dbo.Products
EXEC('Select * from Products') AT [MY_LINKED_SERVER_NAME]
-
Finally, open a new query and execute a query we saved in one of the previous steps:
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Products');
Create Linked Server using Code
In previous section you saw how to create a Linked Server from UI. You can do similar action by code too (see below). Run below script after changing necessary parameters. Assuming your Data Source name on ZappySys Data Gateway UI is 'StripeDSN'
USE [master]
GO
--///////////////////////////////////////////////////////////////////////////////////////
--Run below code in SSMS to create Linked Server and use ZappySys Drivers in SQL Server
--///////////////////////////////////////////////////////////////////////////////////////
//Replace YOUR_GATEWAY_USER, YOUR_GATEWAY_PASSWORD
//Replace localhost with IP/Machine name if ZappySys Gateway Running on different machine other than SQL Server
//Replace Port 5000 if you configured gateway on a different port
--1. Configure your gateway service as per this article https://zappysys.com/links?id=10036
--2. Make sure you have SQL Server Installed. You can download FREE SQL Server Express Edition from here if you dont want to buy Paid version https://www.microsoft.com/en-us/sql-server/sql-server-editions-express
--Uncomment below if you like to drop linked server if it already exists
--EXEC master.dbo.sp_dropserver @server=N'LS_StripeDSN', @droplogins='droplogins'
--3. Create new linked server
EXEC master.dbo.sp_addlinkedserver
@server = N'LS_StripeDSN' --Linked server name (this will be used in OPENQUERY sql
, @srvproduct=N''
---- For MSSQL 2012,2014,2016 and 2019 use below (SQL Server Native Client 11.0)---
, @provider=N'SQLNCLI11'
---- For MSSQL 2022 or higher use below (Microsoft OLE DB Driver for SQL Server)---
--, @provider=N'MSOLEDBSQL'
, @datasrc=N'localhost,5000' --//Machine / Port where Gateway service is running
, @provstr=N'Network Library=DBMSSOCN;'
, @catalog=N'StripeDSN' --Data source name you gave on Gateway service settings
--4. Attach gateway login with linked server
EXEC master.dbo.sp_addlinkedsrvlogin
@rmtsrvname=N'LS_StripeDSN' --linked server name
, @useself=N'False'
, @locallogin=NULL
, @rmtuser=N'YOUR_GATEWAY_USER' --enter your Gateway user name
, @rmtpassword='YOUR_GATEWAY_PASSWORD' --enter your Gateway user's password
GO
--5. Enable RPC OUT (This is Optional - Only needed if you plan to use EXEC(...) AT YourLinkedServerName rather than OPENQUERY
EXEC sp_serveroption 'LS_StripeDSN', 'rpc', true;
EXEC sp_serveroption 'LS_StripeDSN', 'rpc out', true;
--Disable MSDTC - Below needed to support INSERT INTO from EXEC AT statement
EXEC sp_serveroption 'LS_StripeDSN', 'remote proc transaction promotion', false;
--Increase query timeout if query is going to take longer than 10 mins (Default timeout is 600 seconds)
--EXEC sp_serveroption 'LS_StripeDSN', 'query timeout', 1200;
GO
Create View in SQL Server
Finally, use this or similar query in a view or stored procedure, which you will be able to use in Tableau. We will create a view to return invoices:
-
CREATE VIEW vwApiInvoices AS
SELECT * FROM OPENQUERY([MY_LINKED_SERVER_NAME], 'SELECT * FROM Invoices')
Read data in Tableau from SQL Server
Actually, we will be getting data from SQL Server which in turn will be getting data from ZappySys Data Gateway data source. Let's begin and see how to accomplish that:
- Open Tableau Desktop and click File > New
-
To create new Connection click More > Microsoft SQL Server > Enter your credentials to connect to SQL Server (in our example before we used tdsuser):
-
Once connection is created for SQL Server we can read Stripe data 3 different ways:
- Query View which contains OPENQUERY to Linked Server for Stripe data
- Use direct SQL Query using OPENQUERY
- Use Stored Procedure (Mostly useful to parameterize calls
-
See below example to pull data from Stripe in Tableau using SQL View approach:
-
Once your data sources are created you can click on Sheet1 and drag fields to create visualizations for Tableau Dashboard:
Passing Parameters to Stripe calls in Tableau (Dynamic SQL)
Now let's look at scenario where you have to pass parameters to build Dynamic Dashboard. You can try to insert Parameters in your Direct SQL when you build Dynamic SQL but we found some issues with that so we are going to suggest Stored Procedure approach.
For more information on Known issue on
Dynamic Metadata Check this post.
-
First lets create a stored procedure in SQL Server for Parameter Example. Notice how we added WITH RESULT SETS in the code to describe metadata.
--DROP PROC dbo.usp_GetInvoicesByCountry
--GO
/*
Purpose: Parameterize Stripe call via SQL. Call ZappySys Drivers inside SQL Server.
*/
CREATE PROC dbo.usp_GetInvoicesByCountry
@country varchar(100)
AS
DECLARE @sql varchar(max)
--//Escape single ticks carefully
SET @sql = 'SELECT OrderID,CustomerID,Country,Quantity FROM $
WITH (Src=''https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json@filter=Country eq '+ @country +'''
,Filter=''$.value[*]''
,DataFormat=''OData''
)'
DECLARE @sqlFull varchar(max)
SET @sqlFull='SELECT * FROM OPENQUERY( [LS] , ''' + REPLACE( @sql, '''', '''''' ) + ''' )'
PRINT @sqlFull --//For DEBUG purpose
EXECUTE (@sqlFull)
WITH RESULT SETS (
(OrderID int,CustomerID varchar(100),Country varchar(100),Quantity int) --//describe first result. If you don't do this then wont work in Tableau
)
GO
-- Example call
EXEC dbo.usp_GetInvoicesByCountry @country='Germany'
- Once you create a stored procedure go to Tableau datasource and select Database which contains the stored procedure we just created.
-
Now find your stored proc and drag it on the datasource pane. You will see parameters UI as below. You can create new parameter - Select New Parameter under Value Column.
- Thats it now you can reuse your parameterized datasource anywhere in Dashboard.
-
If you have need to select Parameters from predefined values rather than free text then edit your parameter and select List option. Define values you like to select from as below.
-
When you create Tableau Dashboard you will see Parameter dropdown (If you selected List) elase you may see Textbox to enter custom value.
Firewall settings
So far we have assumed that Gateway is running on the same machine as SQL Server. However there will be a case when ZappySys ODBC PowerPack is installed on a different machine than SQL Server. In such case you may have to perform additional Firewall configurations. On most computers firewall settings wont allow outside traffic to ZappySys Data Gateway. In such case perform following steps to allow other machines to connect to Gateway.
Method-1 (Preferred)
If you are using newer version of ZappySys Data Gateway then adding firewall rule is just a single click.
- Search for gateway in start menu and open ZappySys Data Gateway.
- Go to Firewall Tab and click Add Firewall Rule button like below. This will create Firewall rule to all Inbound Traffic on Port 5000 (Unless you changed it).
Method-2
Here is another way to add / edit Inbound Traffic rule in windows firewall. Use below method if you choose to customize your rule (for advanced users).
- Search for Windows Firewall Advanced Security in start menu.
- Under Inbound Rules > Right click and click [New Rule] >> Click Next
- Select Port on Rule Type >> Click Next
- Click on TCP and enter port number under specified local port as 5000 (use different one if you changed Default port) >> Click Next
- Select Profile (i.e. Private, Public) >> Click Next
- Enter Rule name [i.e. ZappySys Data Gateway – Allow Inbound ] >> Click Next
- Click OK to save the rule
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
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
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
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>';
-
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';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
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.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
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'
-
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"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Stripe Connector
Stripe Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. [
Read more...]
Parameter |
Description |
Email Id |
A case-sensitive filter on the list based on the customer’s email field. The value must be a string.
|
Created later than (yyyy-MM-dd) |
Return results where the created field is greater than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or later than (yyyy-MM-dd) |
Return results where the created field is greater than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created earlier than (yyyy-MM-dd) |
Return results where the created field is less than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or earlier than (yyyy-MM-dd) |
Return results where the created field is less than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation. [
Read more...]
Parameter |
Description |
Customer Id |
Unique identifier for the Customer
|
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer. [
Read more...]
Parameter |
Description |
Customer Id |
Unique identifier for the Customer
|
Create a Customer [
Read more...]
Parameter |
Description |
Name |
The customer’s full name or business name.
|
Description |
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
|
Email |
Customer’s email address.
|
Payment Method |
The Id of the PaymentMethod to attach to the customer.
|
Phone |
The customer’s phone number.
|
Balance |
An integer amount in cents that represents the customer’s current balance, which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
|
Coupon |
If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.
|
Preferred Locales |
Customer’s preferred languages, ordered by preference. Example ["en-US", "en-ES"] . Supported languages are listed here https://support.stripe.com/questions/language-options-for-customer-emails
|
Promotion Code |
The API Id of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
|
Tax Id Type (ae_trn, au_abn, br_cnpj, br_cpf etc.) |
Type of the tax Id, one of ae_trn, au_abn, br_cnpj, br_cpf, ca_bn, ca_qst, ch_vat, cl_tin, es_cif, eu_vat, hk_br, id_npwp, in_gst, jp_cn, jp_rn, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, th_vat, tw_vat, us_ein, or za_vat
Option |
Value |
ae_trn |
ae_trn |
au_abn |
au_abn |
br_cnpj |
br_cnpj |
br_cpf |
br_cpf |
ca_bn |
ca_bn |
ca_qst |
ca_qst |
ch_vat |
ch_vat |
cl_tin |
cl_tin |
es_cif |
es_cif |
eu_vat |
eu_vat |
hk_br |
hk_br |
id_npwp |
id_npwp |
in_gst |
in_gst |
jp_cn |
jp_cn |
jp_rn |
jp_rn |
kr_brn |
kr_brn |
li_uid |
li_uid |
mx_rfc |
mx_rfc |
my_frp |
my_frp |
my_itn |
my_itn |
my_sst |
my_sst |
no_vat |
no_vat |
nz_gst |
nz_gst |
ru_inn |
ru_inn |
ru_kpp |
ru_kpp |
sa_vat |
sa_vat |
sg_gst |
sg_gst |
sg_uen |
sg_uen |
th_vat |
th_vat |
tw_vat |
tw_vat |
us_ein |
us_ein |
za_vat |
za_vat |
|
Tax Id Value |
Value of the tax Id.
|
Address Line1 |
Address line 1 (e.g., street, PO Box, or company name).
|
Address Line2 |
Address line 2 (e.g., apartment, suite, unit, or building).
|
Address City |
City, district, suburb, town, or village.
|
Address State |
State, county, province, or region.
|
Address Country |
Two-letter country code
|
Address Postal Code |
ZIP or postal code.
|
Shipping Name |
Customer name.
|
Shipping Phone |
Customer phone (including extension).
|
Shipping Address Line1 |
Address line 1 (e.g., street, PO Box, or company name).
|
Shipping Address Line2 |
Address line 2 (e.g., apartment, suite, unit, or building).
|
Shipping Address City |
City, district, suburb, town, or village.
|
Shipping Address State |
State, county, province, or region.
|
Shipping Address Country |
Two-letter country code
|
Shipping Address Postal Code |
ZIP or postal code.
|
Invoice_Prefix (Must be 3–12 uppercase letters or numbers) |
The prefix for the customer used to generate unique invoice numbers.
|
Invoice Settings - Default Payment Method |
ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for subscriptions and invoices.
|
Invoice Settings - Footer |
Default footer to be displayed on invoices for this customer.
|
Next invoice sequence |
The suffix of the customer’s next invoice number, e.g., 0001.
|
Tax Exempt (none, exempt, reverse) |
Describes the customer tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text Reverse charge.
Option |
Value |
none |
none |
exempt |
exempt |
reverse |
reverse |
|
Updates the specified customer by setting the values of the parameters passed. [
Read more...]
Parameter |
Description |
Customer Id |
Unique identifier for the Customer
|
Name |
The customer’s full name or business name.
|
Description |
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
|
Email |
Customer’s email address.
|
Payment Method |
The Id of the PaymentMethod to attach to the customer.
|
Phone |
The customer’s phone number.
|
Balance (Enter a numeric Value) |
An integer amount in cents that represents the customer’s current balance, which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
|
Coupon |
If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.
|
Preferred Locales |
Customer’s preferred languages, ordered by preference.
|
Promotion Code |
The API Id of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount.
|
Tax Id Type (ae_trn, au_abn, br_cnpj, br_cpf etc.) |
Type of the tax Id, one of ae_trn, au_abn, br_cnpj, br_cpf, ca_bn, ca_qst, ch_vat, cl_tin, es_cif, eu_vat, hk_br, id_npwp, in_gst, jp_cn, jp_rn, kr_brn, li_uid, mx_rfc, my_frp, my_itn, my_sst, no_vat, nz_gst, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, th_vat, tw_vat, us_ein, or za_vat
Option |
Value |
ae_trn |
ae_trn |
au_abn |
au_abn |
br_cnpj |
br_cnpj |
br_cpf |
br_cpf |
ca_bn |
ca_bn |
ca_qst |
ca_qst |
ch_vat |
ch_vat |
cl_tin |
cl_tin |
es_cif |
es_cif |
eu_vat |
eu_vat |
hk_br |
hk_br |
id_npwp |
id_npwp |
in_gst |
in_gst |
jp_cn |
jp_cn |
jp_rn |
jp_rn |
kr_brn |
kr_brn |
li_uid |
li_uid |
mx_rfc |
mx_rfc |
my_frp |
my_frp |
my_itn |
my_itn |
my_sst |
my_sst |
no_vat |
no_vat |
nz_gst |
nz_gst |
ru_inn |
ru_inn |
ru_kpp |
ru_kpp |
sa_vat |
sa_vat |
sg_gst |
sg_gst |
sg_uen |
sg_uen |
th_vat |
th_vat |
tw_vat |
tw_vat |
us_ein |
us_ein |
za_vat |
za_vat |
|
Tax Id Value |
Value of the tax Id.
|
Address Line1 |
Address line 1 (e.g., street, PO Box, or company name).
|
Address Line2 |
Address line 2 (e.g., apartment, suite, unit, or building).
|
Address City |
City, district, suburb, town, or village.
|
Address State |
State, county, province, or region.
|
Address Country |
Two-letter country code
|
Address Postal Code |
ZIP or postal code.
|
Shipping Name |
Customer name.
|
Shipping Phone |
Customer phone (including extension).
|
Shipping Address Line1 |
Address line 1 (e.g., street, PO Box, or company name).
|
Shipping Address Line2 |
Address line 2 (e.g., apartment, suite, unit, or building).
|
Shipping Address City |
City, district, suburb, town, or village.
|
Shipping Address State |
State, county, province, or region.
|
Shipping Address Country |
Two-letter country code
|
Shipping Address Postal Code |
ZIP or postal code.
|
Invoice_Prefix (Must be 3–12 uppercase letters or numbers) |
The prefix for the customer used to generate unique invoice numbers.
|
Invoice Settings - Default Payment Method |
ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for subscriptions and invoices.
|
Invoice Settings - Footer |
Default footer to be displayed on invoices for this customer.
|
next_invoice_sequence |
The suffix of the customer’s next invoice number, e.g., 0001.
|
Tax Exempt (none, exempt, reverse) |
Describes the customer tax exemption status. One of none, exempt, or reverse. When set to reverse, invoice and receipt PDFs include the text Reverse charge.
Option |
Value |
none |
none |
exempt |
exempt |
reverse |
reverse |
|
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first. [
Read more...]
Parameter |
Description |
Active |
Only return products that are active or inactive (e.g., pass false to list all inactive products).
Option |
Value |
True |
True |
False |
False |
|
Created later than (yyyy-MM-dd) |
Return results where the created field is greater than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or later than (yyyy-MM-dd) |
Return results where the created field is greater than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created earlier than (yyyy-MM-dd) |
Return results where the created field is less than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or earlier than (yyyy-MM-dd) |
Return results where the created field is less than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Retrieve a single Product
Retrieves the details of an existing product. Supply the unique product Id from either a product creation request or the product list, and Stripe will return the corresponding product information. [
Read more...]
Parameter |
Description |
Product Id |
Unique identifier for the Product
|
Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it. [
Read more...]
Parameter |
Description |
Product Id |
Unique identifier for the Product
|
Creates a new product. [
Read more...]
Parameter |
Description |
Name |
|
Type (Good or Service) |
Option |
Value |
service |
service |
good |
good |
|
Active |
Option |
Value |
true |
true |
false |
false |
|
Description |
|
Caption (Can be set if Type = good) |
|
Package Dimensions - Height (inch) (Can be set if Type = good) |
|
Package Dimensions - Length (inch) (Can be set if Type = good) |
|
Package Dimensions - Weight (inch) (Can be set if Type = good) |
|
Package Dimensions - Width (inch) (Can be set if Type = good) |
|
Shippable (Can be set if Type = good) |
Option |
Value |
True |
True |
False |
False |
|
Statement Description (Can be set if Type = service) |
|
Unit Label (Can be set if Type = service) |
|
Product URL (Can be set if Type = good) |
|
Image1 |
|
Image2 |
|
Image3 |
|
Image4 |
|
Image5 |
|
Image6 |
|
Image7 |
|
Image8 |
|
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. [
Read more...]
Parameter |
Description |
Product Id |
Unique identifier for the Product
|
Name |
|
Type (Good or Service) |
Option |
Value |
service |
service |
good |
good |
|
Active |
Option |
Value |
true |
true |
false |
false |
|
Description |
|
Caption (Can be set if Type = good) |
|
Package Dimensions - Height (inch) (Can be set if Type = good) |
|
Package Dimensions - Length (inch) (Can be set if Type = good) |
|
Package Dimensions - Weight (inch) (Can be set if Type = good) |
|
Package Dimensions - Width (inch) (Can be set if Type = good) |
|
Shippable (Can be set if Type = good) |
Option |
Value |
True |
True |
False |
False |
|
Statement Description (Can be set if Type = service) |
|
Unit Label (Can be set if Type = service) |
|
Product URL (Can be set if Type = good) |
|
Image1 |
|
Image2 |
|
Image3 |
|
Image4 |
|
Image5 |
|
Image6 |
|
Image7 |
|
Image8 |
|
List All Subscriptions Items
Returns a list of subscriptions items. [
Read more...]
Parameter |
Description |
Subscription Id |
Unique identifier for the Subscription
|
Retrieve a single Subscription
Returns a single subscription. [
Read more...]
Parameter |
Description |
Subscription Id |
Unique identifier for the Subscription
|
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [
Read more...]
Parameter |
Description |
Customer Id |
Only return invoices for the customer specified by this customer Id.
|
Status (draft or open or paid or uncollectible or void) |
The status of the invoice, one of draft, open, paid, uncollectible, or void
Option |
Value |
draft |
draft |
open |
open |
paid |
paid |
uncollectible |
uncollectible |
void |
void |
|
Subscription Id |
Only return invoices for the subscription specified by this subscription Id.
|
Collection method (charge_automatically or send_invoice) |
The collection method of the invoice to retrieve. Either charge_automatically or send_invoice.
Option |
Value |
charge_automatically |
charge_automatically |
send_invoice. |
send_invoice. |
|
Created later than (yyyy-MM-dd) |
Return results where the created field is greater than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or later than (yyyy-MM-dd) |
Return results where the created field is greater than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created earlier than (yyyy-MM-dd) |
Return results where the created field is less than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or earlier than (yyyy-MM-dd) |
Return results where the created field is less than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Due Date later than (yyyy-MM-dd) |
Return results where the Due Date field is greater than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Due Date on or later than (yyyy-MM-dd) |
Return results where the Due Date field is greater than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Due Date earlier than (yyyy-MM-dd) |
Return results where the Due Date field is less than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Due Date on or earlier than (yyyy-MM-dd) |
Return results where the Due Date field is less than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Retrieves the invoice with the given Id. [
Read more...]
Parameter |
Description |
Invoice Id |
Returns an invoice for the Invoice Id.
|
Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided. [
Read more...]
Parameter |
Description |
Invoice Id |
Delete an invoice for the Invoice Id.
|
Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method. [
Read more...]
Parameter |
Description |
Invoice Id |
Finalize an invoice for the Invoice Id.
|
Auto Advance |
Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice’s state will not automatically advance without an explicit action.
Option |
Value |
False |
False |
True |
True |
|
Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so. [
Read more...]
Parameter |
Description |
Invoice Id |
Pay an invoice for the Invoice Id.
|
Forgive |
Option |
Value |
False |
False |
True |
True |
|
Off Season |
Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).
Option |
Value |
False |
False |
True |
True |
|
Paid Out Of Band |
Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made.
Option |
Value |
False |
False |
True |
True |
|
Payment Method Id |
A PaymentMethod to be charged. The PaymentMethod must be the Id of a PaymentMethod belonging to the customer associated with the invoice being paid.
|
Source Id |
A payment source to be charged. The source must be the Id of a source belonging to the customer associated with the invoice being paid.
|
Send an Invoice For Manual Payment
Send an Invoice For Manual Payment [
Read more...]
Parameter |
Description |
Invoice Id |
Send an invoice for the Invoice Id.
|
Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. [
Read more...]
Parameter |
Description |
Invoice Id |
Void an invoice for the Invoice Id.
|
Mark an Invoice As Uncollectible
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes. [
Read more...]
Parameter |
Description |
Invoice Id |
Mark Uncollectible for the Invoice Id.
|
Retrieve an Invoice Line Items
When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. [
Read more...]
Parameter |
Description |
Invoice Id |
Retrieve an invoice line items for the Invoice Id.
|
Retrieve an Upcoming Invoice
At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. [
Read more...]
Parameter |
Description |
Customer Id |
The identifier of the customer whose upcoming invoice you’d like to retrieve.
|
Subscription Id |
The identifier of the subscription for which you’d like to retrieve the upcoming invoice.
|
Retrieve an Upcoming Invoice Line Items
When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. [
Read more...]
Parameter |
Description |
Customer Id |
The identifier of the customer whose upcoming invoice you’d like to retrieve.
|
Subscription Id |
The identifier of the subscription for which you’d like to retrieve the upcoming invoice.
|
This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers. [
Read more...]
Parameter |
Description |
Customer Id |
The Id of the customer who will be billed.
|
Auto Advance |
Controls whether Stripe will perform automatic collection of the invoice. When false, the invoice’s state will not automatically advance without an explicit action.
Option |
Value |
False |
False |
True |
True |
|
Collection Method (charge_automatically or send_invoice) |
Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to charge_automatically.
Option |
Value |
charge_automatically |
charge_automatically |
send_invoice |
send_invoice |
|
Description |
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
|
Subscription Id |
The Id of the subscription to invoice, if any. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will only include pending invoice items for that subscription and pending invoice items not associated with any subscription. The subscription’s billing cycle and regular subscription events won’t be affected.
|
Account Tax Id |
The account tax Ids associated with the invoice. Only editable when the invoice is a draft.
|
Application Fee Amount |
A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account.
|
Days Until Due (Can be set if Collection Method = send_invoice) |
The number of days from when the invoice is created until it is due. Valid only for invoices where collection_method=send_invoice.
|
Default Payment Method Id |
ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.
|
Default Source |
ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.
|
Default Tax Rates |
The tax rates that will apply to any line item that does not have tax_rates set.
|
Discounts Coupon Id |
ID of the coupon to create a new discount for.
|
Discounts Discount Id |
ID of an existing discount on the object (or one of its ancestors) to reuse.
|
Due Date |
The date on which payment for this invoice is due. Valid only for invoices where collection_method=send_invoice
|
Footer |
Footer to be displayed on the invoice.
|
Statement Desctiption |
Extra information about a charge for the customer’s credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default statement_descriptor will be set to the first subscription item’s product’s statement_descriptor.
|
Transfer Data Destination Id |
ID of an existing, connected Stripe account.
|
Transfer Data Amount |
The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
|
Lines Object |
|
Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable. [
Read more...]
Parameter |
Description |
Invoice Id |
Update an invoice for the Invoice Id
|
Auto Advance |
Controls whether Stripe will perform automatic collection of the invoice.
Option |
Value |
False |
False |
True |
True |
|
Collection Method (charge_automatically or send_invoice) |
Either charge_automatically or send_invoice. This field can be updated only on draft invoices.
Option |
Value |
charge_automatically |
charge_automatically |
send_invoice |
send_invoice |
|
Description |
An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.
|
Account Tax Id |
The account tax Ids associated with the invoice. Only editable when the invoice is a draft.
|
Application Fee Amount |
A fee in cents that will be applied to the invoice and transferred to the application owner’s Stripe account.
|
Days Until Due (Can be set if Collection Method = send_invoice) |
The number of days from which the invoice is created until it is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
|
Default Payment Method Id |
ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.
|
Default Source |
ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.
|
Default Tax Rates |
The tax rates that will apply to any line item that does not have tax_rates set. Pass an empty string to remove previously-defined tax rates.
|
Discounts Coupon Id |
ID of the coupon to create a new discount for.
|
Discounts Discount Id |
ID of an existing discount on the object (or one of its ancestors) to reuse.
|
Due Date |
The date on which payment for this invoice is due. Only valid for invoices where collection_method=send_invoice. This field can only be updated on draft invoices.
|
Footer |
Footer to be displayed on the invoice.
|
Statement Desctiption |
Extra information about a charge for the customer’s credit card statement. It must contain at least one letter.
|
Transfer Data Destination Id |
ID of an existing, connected Stripe account.
|
Transfer Data Amount |
The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred.
|
Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified. [
Read more...]
Parameter |
Description |
Customer Id |
Create an invoice item for the Customer Id
|
Amount |
The integer amount in cents of the charge to be applied to the upcoming invoice. Passing in a negative amount will reduce the amount_due on the invoice.
|
Currency |
Three-letter ISO currency code, in lowercase.
|
Description |
An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
Period Start |
The start of the period.
|
Period End |
The end of the period, which must be greater than or equal to the start.
|
Price Id |
The Id of the price object.
|
Discountable |
Option |
Value |
True |
True |
False |
False |
|
Discounts Coupon Id |
|
Discounts Discount Id |
|
Invoice Id |
The Id of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice.
|
Price Data Currency |
Three-letter ISO currency code, in lowercase.
|
Price Data Product |
The Id of the product that this price will belong to.
|
Price Data Unit Amount Decimal |
Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
|
Price Data Unit Amount |
A positive integer in cents (or 0 for a free price) representing how much to charge. Only one of unit_amount and unit_amount_decimal can be set.
|
Quantity |
Non-negative integer. The quantity of units for the invoice item.
|
Subscription Id |
The Id of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
|
Tax Rates |
The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
|
Unit Amount Decimal |
Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
|
Unit Amount |
The integer unit amount in cents of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.
|
Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first. [
Read more...]
Parameter |
Description |
Customer Id |
Only return invoices for the customer specified by this customer Id.
|
Invoice Id |
Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.
|
Pending |
Set to true to only show pending invoice items, which are not yet attached to any invoices. Set to false to only show invoice items already attached to invoices. If unspecified, no filter is applied.
Option |
Value |
true |
true |
false |
false |
|
Created later than (yyyy-MM-dd) |
Return results where the created field is greater than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or later than (yyyy-MM-dd) |
Return results where the created field is greater than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created earlier than (yyyy-MM-dd) |
Return results where the created field is less than this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Created on or earlier than (yyyy-MM-dd) |
Return results where the created field is less than or equal to this value.
Option |
Value |
today |
today |
yesterday |
yesterday |
monthstart |
monthstart |
monthend |
monthend |
yearstart |
yearstart |
yearend |
yearend |
weekstart |
weekstart |
weekend |
weekend |
yearstart-1y |
yearstart-1y |
yearend-1y |
yearend-1y |
monthstart-1d |
monthstart-1d |
monthend+1d |
monthend+1d |
2022-01-31 |
2022-01-31 |
2022-01-31 23:59:59 |
2022-01-31 23:59:59 |
|
Retrieves the invoice item with the given Id. [
Read more...]
Parameter |
Description |
Invoice Item Id |
Retrieve an invoice item for the Invoice Id.
|
Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice. [
Read more...]
Parameter |
Description |
Invoice Item Id |
Delete an invoice item for the Invoice Id.
|
Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed. [
Read more...]
Parameter |
Description |
Invoice Item Id |
Update an invoice item.
|
Amount |
The integer amount in cents of the charge to be applied to the upcoming invoice. Passing in a negative amount will reduce the amount_due on the invoice.
|
Description |
An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
|
Period Start |
The start of the period.
|
Period End |
The end of the period, which must be greater than or equal to the start.
|
Price Id |
The Id of the price object.
|
Discountable |
Option |
Value |
True |
True |
False |
False |
|
Discounts Coupon Id |
|
Discounts Discount Id |
|
Price Data Currency |
Three-letter ISO currency code, in lowercase.
|
Price Data Product |
The Id of the product that this price will belong to.
|
Price Data Unit Amount Decimal |
Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
|
Price Data Unit Amount |
A positive integer in cents (or 0 for a free price) representing how much to charge. Only one of unit_amount and unit_amount_decimal can be set.
|
Quantity |
Non-negative integer. The quantity of units for the invoice item.
|
Tax Rates |
The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item.
|
Unit Amount Decimal |
Same as unit_amount, but accepts a decimal value in cents with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.
|
Unit Amount |
The integer unit amount in cents of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.
|
You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [
Read more...]
Parameter |
Description |
Customer Id |
Only return invoices for the customer specified by this customer Id.
|
Status (draft or open or paid or uncollectible or void) |
The status of the invoice, one of draft, open, paid, uncollectible, or void
Option |
Value |
draft |
draft |
open |
open |
paid |
paid |
uncollectible |
uncollectible |
void |
void |
|
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL. [
Read more...]
Parameter |
Description |
Url |
API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
|
Body |
Request Body content goes here
|
IsMultiPart |
Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value)
==== Raw Upload (Content-Type: application/octet-stream) =====
To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip )
==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) =====
To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored.
If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type.
See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored).
file1=@c:\data\Myfile1.txt
file2=@c:\data\Myfile2.json
file2.Content-Type=application/json
SomeField1=aaaaaaa
SomeField1.Content-Type=text/plain
SomeField2=12345
SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab
SomeFieldStartingWithAtSign=\@MyTwitterHandle
|
Filter |
Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
|
Headers |
Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair
|
Stripe Connector Examples for Tableau Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
Read all customers
Read a customer
SELECT * FROM Customers
WHERE Id = 'abc'
Get Customers (Filter by Date) [Read more...]
Using date time requires yyyy-MM-dd format usage
SELECT * FROM Customers
WHERE Created > '2010-01-01'
Insert a customer
INSERT INTO Customers
([Name]
, [Email]
, [Description]
, [Phone]
, [Balance]
, [AddressLine1]
, [AddressLine2]
, [AddressCity]
, [AddressState]
, [AddressCountry]
, [AddressPostalCode]
, [InvoicePrefix]
)
VALUES('Cust-1'
, 'email@abc.com'
, 'Some desc'
, '+1 222-333-4444'
, 0
, '55 Main St.'
, 'Suite 100'
, 'New York'
, 'NY'
, 'USA'
, '07204' --JSON fragment
, 'INVC'
)
Update a customer
UPDATE Customers
SET Name='Cust1-Updated'
, Email='a-updated@b.com'
, Phone='+1 800-123-2345'
, Description='Desc-updated'
, AddressLine1='Line-1-upd'
, AddressLine2='Line-2-upd'
, AddressCity='SomeCity'
, AddressState='NY'
, AddressCountry='USA'
, AddressPostalCode='112233'
, ShippingPhone='+1 800-123-2345'
, ShippingName='SHName-upd'
, ShippingAddressLine1='Line-1-upd'
, ShippingAddressLine2='Line-2-upd'
, ShippingAddressCity='SomeCity'
, ShippingAddressState='NY'
, ShippingAddressCountry='USA'
, ShippingAddressPostalCode='112233'
, Balance=100
WHERE Id='cus_IcUG2lD69ZHuol'
Delete a customer by Id
DELETE FROM Customers
WHERE Id = 'abc'
Read all products
Read a product
SELECT * FROM Products
WHERE Id = 'abc'
Read a product
UPDATE Products
SET [name] = 'new name'
WHERE Id = 'abc'
Inserts a product
INSERT INTO Products
( [Name]
, [Caption]
, [Description]
, [Type]
--, [UnitLabel] --only when product type=service
, [Active]
, [PackageDimensionsHeight]
, [PackageDimensionsWidth]
, [PackageDimensionsLength]
, [PackageDimensionsWeight]
, [URL]
, [Image1]
, [Image2]
, [Image3]
)
VALUES('SSIS PowerPack 3'
, 'SSIS Caption 3'
, 'SSIS PowerPack description long ....'
, 'good' --or service
--, 'Unit label' --only when product type=service
, 'True' --active ?
, '12'
, '13'
, '14'
, '1000'
, 'https://zappysys.com/products/ssis-powerpack/'
, 'https://zappysys.com/images/tech/web-api-logo.png'
, 'https://zappysys.com/images/tech/xml-logo.png'
, 'https://zappysys.com/images/tech/salesforce-logo.png'
)
Product Update example. When supply Image1,Image2... it will reset previous images.
UPDATE Products
SET [Name]='SSIS PowerPack 3 - Updated'
, [Caption]='Caption-updated'
, [Description]='Desc-updated'
--, [UnitLabel] --only when product type=service
, [Active]='true'
, [PackageDimensionsHeight]=12
, [PackageDimensionsWidth]=13
, [PackageDimensionsLength]=14
, [PackageDimensionsWeight]=1122
, [URL]='https://zappysys.com/products/ssis-powerpack/?updated=1'
, [Image1]='https://zappysys.com/images/tech/web-api-logo.png?updated=1'
, [Image2]='https://zappysys.com/images/tech/xml-logo.png?updated=1'
WHERE Id='prod_MiSJzGZ8PDM9uh'
Delete a product
DELETE FROM Products
WHERE Id = 'abc'
Read all invoices
Read an invoice
SELECT * FROM Invoices
WHERE Id = 'abc'
Get all Invoice Line Items [Read more...]
Read all Invoice Line Items
SELECT * FROM InvoiceItems
Get an Invoice Line Item [Read more...]
Read an invoice line item by Id
SELECT * FROM InvoiceItems
WHERE Id = 'abc'
Insert an invoice
INSERT INTO Invoices([Customer],[AmountRemaining])
VALUES ('cus_LqWX1s0E32JJeZL', 12345)
Update an invoice
UPDATE Invoices
SET [DaysUntilDue] = 20
WHERE Id = 'abc'
Delete an invoice
DELETE FROM Invoices
WHERE Id = 'abc'
Conclusion
In this article we discussed how to connect to Stripe in Tableau and integrate data without any coding. Click here to Download Stripe Connector for Tableau and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Stripe Connector for Tableau
Documentation
More integrations
Other application integration scenarios for Stripe
Other connectors for Tableau
Download Stripe Connector for Tableau
Documentation
Common Searches:
How to connect Stripe in Tableau?
How to get Stripe data in Tableau?
How to read Stripe data in Tableau?
How to load Stripe data in Tableau?
How to import Stripe data in Tableau?
How to pull Stripe data in Tableau?
How to push data to Stripe in Tableau?
How to write data to Stripe in Tableau?
How to POST data to Stripe in Tableau?
Call Stripe API in Tableau
Consume Stripe API in Tableau
Stripe Tableau Automate
Stripe Tableau Integration
Integration Stripe in Tableau
Consume real-time Stripe data in Tableau
Consume real-time Stripe API data in Tableau
Stripe ODBC Driver | ODBC Driver for Stripe | ODBC Stripe Driver | SSIS Stripe Source | SSIS Stripe Destination
Connect Stripe in Tableau
Load Stripe in Tableau
Load Stripe data in Tableau
Read Stripe data in Tableau
Stripe API Call in Tableau