Stripe Connector for Azure Data Factory (SSIS)This connector support read/write operations for Stripe APIs In this article you will learn how to quickly and efficiently integrate Stripe data in Azure Data Factory (SSIS) without coding. We will use high-performance Stripe Connector to easily connect to Stripe and then access the data inside Azure Data Factory (SSIS). Let's follow the steps below to see how we can accomplish that! Stripe Connector for Azure Data Factory (SSIS) is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to Stripe in other apps
|
Create SSIS package
First of all, create an SSIS package, which will connect to Stripe in SSIS. Once you do that, you are one step closer to deploying and running it in Azure-SSIS integration runtime in Azure Data Factory (ADF). Then simply proceed to the next step - creating and configuring Azure Blob Storage Container.
Prepare custom setup files for Azure-SSIS runtime
Now it's time to start preparing custom setup files for Azure-SSIS runtime. During Azure-SSIS runtime creation you can instruct ADF to perform a custom setup on a VM (Azure-SSIS node); i.e. to run the custom installer, copy files, execute PowerShell scripts, etc. In that case, your custom setup files are downloaded and run in the Azure-SSIS node (a VM) when you start the runtime. In this section we will prepare custom setup files so that you can run SSIS packages with SSIS PowerPack connectors inside in Azure-SSIS runtime.
Trial Users
Use the step below if you are a Trial User, when you did not purchase a license key. Proceed with these steps:
-
Download ~/Views/IntegrationHub/ContentBlocks/Links/SSIS-PowerPack/DownloadTrial.cshtmlSSIS PowerPack trial installer.
Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit_Trial.msi.
- Create a text file and name it main.cmd (make it all lowercase, very important).
-
Copy and paste this script into it and save it:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR% echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt" dir /s /b > "%DIR%\file_list.txt" echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt" ::Install SSIS PowerPack msiexec /i "SSISPowerPackSetup_64bit_Trial.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_trial_install_log.txt" echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt" dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" echo DONE : %TIME% >> "%DIR%\steps_log.txt" echo complete
This is the entry-point script that is executed when Azure-SSIS runtime is started. - At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit_Trial.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.
Paid Customers
Use the steps below if you are a Paid Customer, when you purchased a license. Proceed with these steps:
-
Download SSIS PowerPack paid installer.
Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit.msi.
- Have your SSIS PowerPack license key handy, we will need it in the below script.
- Create a text file and name it main.cmd (make it all lowercase, very important).
- Copy and paste the below script into it.
- Paste your license key by replacing parameter's
--register
argument with your real license key. -
Finally, save main.cmd:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR% echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt" dir /s /b > "%DIR%\file_list.txt" echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt" ::Install SSIS PowerPack msiexec /i "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_install_log.txt" echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt" ::Activate PowerPack license (Optional) "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --register "lgGAAO0-----REPLACE-WITH-YOUR-LICENSE-KEY-----czM=" --logfile "%DIR%\powerpack_register_log.txt" ::Show System Info echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt" "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt" echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt" dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" echo DONE : %TIME% >> "%DIR%\steps_log.txt" echo complete
This is the entry-point script that is executed when Azure-SSIS runtime is started. - At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.
Upload custom setup files to Azure Blob Storage container
Within Azure Blob Storage container we will store custom setup files we prepared in the previous step so that Azure-SSIS can use them in custom setup process. Just perform these very simple, but very important steps:
-
Create Azure Blob Storage container, if you haven't done it already
Make sure you create and use Azure Blob Storage container instead of Azure Data Lake Storage folder. Azure Data Lake Storage won't allow creating an SAS URI for the container, which is a crucial step in the process.
-
Find Blob Containers node, right-click on it and hit Create Blob Container option:
-
Upload the two custom setup files — main.cmd & the MSI installer — into your Azure Blob Storage container's folder:
- It was easy, wasn't it? It's time we create an SAS URI in the next step.
Create SAS URI for Azure Blob Container
Once you have custom setup files prepared, it's time we generate an SAS URI. This SAS URI will be used by a new Azure-SSIS runtime to install SSIS PowerPack inside the runtime's node, a VM. Let's proceed together by performing the steps below:
- Install and launch Azure Storage Explorer.
-
Right-click on the Storage Accounts node and then hit Connect to Azure storage... menu item:
- Proceed by right-clicking on that container node and select Get Shared Access Signature... option.
-
Next, set the Expiry time field to a date far in the future.
If you restart Azure-SSIS runtime and your SAS URI is expired by that time, it will not start.
-
Select Read, Create, Write, and List permissions:
We also recommend to add Delete permission too to support future functionality.
-
Copy SAS URL to the clipboard and save it for the next step:
You can also generate and copy SAS URL from within Azure Portal itself:
Create Azure-SSIS integration runtime
Once you have the SAS URL we obtained in the previous step, we are ready to move on to create an Azure-SSIS runtime in Azure Data Factory:
- Firstly, perform the steps described in Create an Azure-SSIS integration runtime article in Azure Data Factory reference.
-
In Advanced settings page section, configure Custom setup container SAS URI you obtained in the previous step:
-
And you are done! That was quick! You can see your Azure-SSIS runtime up and running:
The custom setup script is executed only once — at the time an Azure-SSIS runtime is started.
It is also executed if you stop and start Azure-SSIS runtime again.
Deploy SSIS package in Visual Studio
We are ready to deploy the SSIS package to Azure-SSIS runtime. Once you do that, proceed to the next step for the grand finale!
Execute SSIS package in SQL Server Management Studio (SSMS)
After all hard work, we are ready to execute SSIS package in SQL Server Management Studio (SSMS):
- Connect to the SQL Server which is linked to your Azure-SSIS runtime and contains SSISDB database.
-
Navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and hit Execute...:
-
To view the status of the past execution, navigate to
Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and select Reports » Standard Reports » All Executions menu item:
Scenarios
Moving SSIS PowerPack license to another Azure-SSIS runtime
If you are a Paid Customer, there will be a time when you no longer use Azure-SSIS runtime or you need to use your license on a different ADF instance. To transfer a license from one Azure-SSIS runtime to another, perform these steps:
-
Copy & paste this script into main.cmd we used in the previous step:
set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR% echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt" dir /s /b > "%DIR%\file_list.txt" echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt" ::Install SSIS PowerPack msiexec /i "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q /L*V "%DIR%\powerpack_install_log.txt" echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt" ::De-Activate same license "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --unregister --logfile "%DIR%\powerpack_un_register_log.txt" ::Show System Info echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt" "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt" echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt" dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*" /s /b >> "%DIR%\installed_files.txt" echo DONE : %TIME% >> "%DIR%\steps_log.txt" echo complete
- Start Azure-SSIS runtime.
This will unregister your license on the original Azure-SSIS runtime.
- Stop Azure-SSIS runtime to deallocate resources in Azure.
- Now you are free to activate it on another Azure-SSIS runtime.
Actions supported by Stripe Connector
Stripe Connector supports following actions for REST API integration:
Create a Customer
Description
Create a Customer.
Parameters
You can provide the following parameters to this action:
-
Name
-
Description
-
Email
-
Payment Method
-
Phone
-
Balance
-
Coupon
-
Preferred Locales
-
Promotion Code
-
Tax Id Type (ae_trn, au_abn, br_cnpj, br_cpf etc.)
-
Tax Id Value
-
Address Line1
-
Address Line2
-
Address City
-
Address State
-
Address Country
-
Address Postal Code
-
Shipping Name
-
Shipping Phone
-
Shipping Address Line1
-
Shipping Address Line2
-
Shipping Address City
-
Shipping Address State
-
Shipping Address Country
-
Shipping Address Postal Code
-
Invoice_Prefix (Must be 3–12 uppercase letters or numbers)
-
Invoice Settings - Default Payment Method
-
Invoice Settings - Footer
-
Next invoice sequence
-
Tax Exempt (none, exempt, reverse)
Input Fields
You can provide the following fields to this action:
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
Balance
-
Coupon
-
tax_id_data_type
-
tax_id_data_value
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
DefaultSource
-
DefaultCurrency
-
Balance
-
Coupon
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
-
LiveMode
-
Metadata
Visit documentation for more information.
Create a Product
Description
Creates a new product.
Parameters
You can provide the following parameters to this action:
-
Name
-
Type (Good or Service)
-
Active
-
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)
-
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
Input Fields
You can provide the following fields to this action:
-
Name
-
Caption
-
Description
-
Type
-
Active
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Shippable
-
Image1
-
Image2
-
Image3
-
Image4
-
Image5
-
Image6
-
Image7
-
Image8
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Caption
-
Description
-
Active
-
Created
-
Updated
-
Type
-
Object
-
Attributes
-
LiveMode
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Images
-
TaxCodeId
-
TaxCodeName
-
PriceUnitAmount
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringUsageType
-
Shippable
-
DeactivatedOn
Visit documentation for more information.
Create an Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Auto Advance
-
Collection Method (charge_automatically or send_invoice)
-
Description
-
Subscription Id
-
Account Tax Id
-
Application Fee Amount
-
Days Until Due (Can be set if Collection Method = send_invoice)
-
Default Payment Method Id
-
Default Source
-
Default Tax Rates
-
Discounts Coupon Id
-
Discounts Discount Id
-
Due Date
-
Footer
-
Statement Desctiption
-
Transfer Data Destination Id
-
Transfer Data Amount
-
Lines Object
Input Fields
You can provide the following fields to this action:
-
InvoiceID
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
Subscription
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Create an Invoice Item
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Amount
-
Currency
-
Description
-
Period Start
-
Period End
-
Price Id
-
Discountable
-
Discounts Coupon Id
-
Discounts Discount Id
-
Invoice Id
-
Price Data Currency
-
Price Data Product
-
Price Data Unit Amount Decimal
-
Price Data Unit Amount
-
Quantity
-
Subscription Id
-
Tax Rates
-
Unit Amount Decimal
-
Unit Amount
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Delete a Customer
Description
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
Parameters
You can provide the following parameters to this action:
-
Customer Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
DefaultSource
-
DefaultCurrency
-
Balance
-
Coupon
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
-
LiveMode
-
Metadata
Visit documentation for more information.
Delete a Draft Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Delete a Product
Description
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.
Parameters
You can provide the following parameters to this action:
-
Product Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Caption
-
Description
-
Active
-
Created
-
Updated
-
Type
-
Object
-
Attributes
-
LiveMode
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Images
-
TaxCodeId
-
TaxCodeName
-
PriceUnitAmount
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringUsageType
-
Shippable
-
DeactivatedOn
Visit documentation for more information.
Delete an Invoice Item
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Item Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Finalize an Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
-
Auto Advance
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
List All Customers
Description
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
Parameters
You can provide the following parameters to this action:
-
Email Id
-
Created later than (yyyy-MM-dd)
-
Created on or later than (yyyy-MM-dd)
-
Created earlier than (yyyy-MM-dd)
-
Created on or earlier than (yyyy-MM-dd)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
DefaultSource
-
DefaultCurrency
-
Balance
-
Coupon
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
-
LiveMode
-
Metadata
Visit documentation for more information.
List All Invoice Items
Description
Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Invoice Id
-
Pending
-
Created later than (yyyy-MM-dd)
-
Created on or later than (yyyy-MM-dd)
-
Created earlier than (yyyy-MM-dd)
-
Created on or earlier than (yyyy-MM-dd)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
InvoiceId
-
Object
-
Amount
-
AmountDecimal
-
Currency
-
Customer
-
Date
-
Description
-
Discountable
-
Discounts
-
Livemode
-
PeriodEnd
-
PeriodStart
-
PriceID
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceLivemode
-
PriceLookupKey
-
PriceNickname
-
PriceProductId
-
PriceRecurringAggregateUsage
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringTrialPeriodDays
-
PriceRecurringUsageType
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
Proration
-
Quantity
-
SubscriptionId
-
TaxRates
-
UnitAmount
-
UnitAmountDecimal
Visit documentation for more information.
List All Invoices
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Status (draft or open or paid or uncollectible or void)
-
Subscription Id
-
Collection method (charge_automatically or send_invoice)
-
Created later than (yyyy-MM-dd)
-
Created on or later than (yyyy-MM-dd)
-
Created earlier than (yyyy-MM-dd)
-
Created on or earlier than (yyyy-MM-dd)
-
Due Date later than (yyyy-MM-dd)
-
Due Date on or later than (yyyy-MM-dd)
-
Due Date earlier than (yyyy-MM-dd)
-
Due Date on or earlier than (yyyy-MM-dd)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
List All Products
Description
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
Parameters
You can provide the following parameters to this action:
-
Active
-
Created later than (yyyy-MM-dd)
-
Created on or later than (yyyy-MM-dd)
-
Created earlier than (yyyy-MM-dd)
-
Created on or earlier than (yyyy-MM-dd)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Caption
-
Description
-
Active
-
Created
-
Updated
-
Type
-
Object
-
Attributes
-
LiveMode
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Images
-
TaxCodeId
-
TaxCodeName
-
PriceUnitAmount
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringUsageType
-
Shippable
-
DeactivatedOn
Visit documentation for more information.
List All Quotes
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Status (draft or open or paid or uncollectible or void)
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
object
-
amount_subtotal
-
amount_total
-
application
-
application_fee_amount
-
application_fee_percent
-
automatic_tax_enabled
-
automatic_tax_status
-
collection_method
-
recurring_amount_subtotal
-
recurring_amount_total
-
recurring_interval
-
recurring_interval_count
-
recurring_total_amount_discount
-
recurring_total_amount_shipping
-
recurring_total_amount_tax
-
upfront_amount_subtotal
-
upfront_amount_total
-
upfront_total_amount_discount
-
upfront_total_amount_shipping
-
upfront_total_amount_tax
-
Created
-
currency
-
customer
-
default_tax_rates
-
description
-
discounts
-
expires_at
-
footer
-
from_quote
-
header
-
invoice
-
invoice_settings_days_until_due
-
livemode
-
number
-
on_behalf_of
-
status
-
status_transitions_accepted_at
-
status_transitions_canceled_at
-
status_transitions_finalized_at
-
subscription
-
subscription_data_description
-
subscription_data_effective_date
-
subscription_data_trial_period_days
-
subscription_schedule
-
test_clock
-
total_amount_discount
-
total_amount_shipping
-
total_details_amount_tax
-
transfer_data
Visit documentation for more information.
List All Subscriptions
Description
Returns a list of subscriptions.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Application
-
ApplicationFeePercent
-
AutomaticTaxEnabled
-
BillingCycleAnchor
-
BillingThresholds
-
CancelAt
-
CancelAtPeriodEnd
-
CanceledAt
-
CollectionMethod
-
Currency
-
Created
-
CurrentPeriodEnd
-
CurrentPeriodStart
-
Customer
-
DaysUntilDue
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
EndedAt
-
ItemsObject
-
ItemsData
-
ItemsHasMore
-
ItemsTotalCount
-
ItemsUrl
-
LatestInvoice
-
LiveMode
-
NextPendingInvoiceItemInvoice
-
OnBehalfOf
-
PauseCollection
-
PaymentSettingsPaymentMethodOptions
-
PaymentSettingsPaymentMethodTypes
-
PaymentSettingsSaveDefaultPaymentMethod
-
PendingInvoiceItemInterval
-
PendingSetupIntent
-
PendingUpdate
-
PlanId
-
PlanObject
-
PlanActive
-
PlanAggregateUsage
-
PlanAmount
-
PlanAmountDecimal
-
PlanBillingScheme
-
PlanCreated
-
PlanCurrency
-
PlanInterval
-
PlanIntervalCount
-
PlanLiveMode
-
PlanNickName
-
PlanProductId
-
PlanTiersMode
-
PlanTransformUsage
-
PlanTrialPeriodDays
-
PlanUsageType
-
Quantity
-
Schedule
-
StartDate
-
Status
-
TestClock
-
TransferData
-
TrialEnd
-
TrialStart
Visit documentation for more information.
List All Subscriptions Items
Description
Returns a list of subscriptions items.
Parameters
You can provide the following parameters to this action:
-
Subscription Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
SubscriptionId
-
ProductId
-
Quantity
-
Object
-
BillingThresholds
-
Created
-
PriceID
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceCustomUnitAmount
-
PriceLivemode
-
PriceLookupKey
-
PriceNickname
-
PriceRecurringAggregateUsage
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringTrialPeriodDays
-
PriceRecurringUsageType
-
PriceTaxBehaviour
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
TaxRates
Visit documentation for more information.
Mark an Invoice As Uncollectible
Description
Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Pay an Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
-
Forgive
-
Off Season
-
Paid Out Of Band
-
Payment Method Id
-
Source Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Retrieve a Customer
Description
Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.
Parameters
You can provide the following parameters to this action:
-
Customer Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
DefaultSource
-
DefaultCurrency
-
Balance
-
Coupon
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
-
LiveMode
-
Metadata
Visit documentation for more information.
Retrieve a single Product
Description
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.
Parameters
You can provide the following parameters to this action:
-
Product Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Caption
-
Description
-
Active
-
Created
-
Updated
-
Type
-
Object
-
Attributes
-
LiveMode
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Images
-
TaxCodeId
-
TaxCodeName
-
PriceUnitAmount
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringUsageType
-
Shippable
-
DeactivatedOn
Visit documentation for more information.
Retrieve a single Subscription
Description
Returns a single subscription.
Parameters
You can provide the following parameters to this action:
-
Subscription Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Application
-
ApplicationFeePercent
-
AutomaticTaxEnabled
-
BillingCycleAnchor
-
BillingThresholds
-
CancelAt
-
CancelAtPeriodEnd
-
CanceledAt
-
CollectionMethod
-
Currency
-
Created
-
CurrentPeriodEnd
-
CurrentPeriodStart
-
Customer
-
DaysUntilDue
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
EndedAt
-
ItemsObject
-
ItemsData
-
ItemsHasMore
-
ItemsTotalCount
-
ItemsUrl
-
LatestInvoice
-
LiveMode
-
NextPendingInvoiceItemInvoice
-
OnBehalfOf
-
PauseCollection
-
PaymentSettingsPaymentMethodOptions
-
PaymentSettingsPaymentMethodTypes
-
PaymentSettingsSaveDefaultPaymentMethod
-
PendingInvoiceItemInterval
-
PendingSetupIntent
-
PendingUpdate
-
PlanId
-
PlanObject
-
PlanActive
-
PlanAggregateUsage
-
PlanAmount
-
PlanAmountDecimal
-
PlanBillingScheme
-
PlanCreated
-
PlanCurrency
-
PlanInterval
-
PlanIntervalCount
-
PlanLiveMode
-
PlanNickName
-
PlanProductId
-
PlanTiersMode
-
PlanTransformUsage
-
PlanTrialPeriodDays
-
PlanUsageType
-
Quantity
-
Schedule
-
StartDate
-
Status
-
TestClock
-
TransferData
-
TrialEnd
-
TrialStart
Visit documentation for more information.
Retrieve an Invoice
Description
Retrieves the invoice with the given Id.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Retrieve an Invoice Item
Description
Retrieves the invoice item with the given Id.
Parameters
You can provide the following parameters to this action:
-
Invoice Item Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
InvoiceId
-
Object
-
Amount
-
AmountDecimal
-
Currency
-
Customer
-
Date
-
Description
-
Discountable
-
Discounts
-
Livemode
-
PeriodEnd
-
PeriodStart
-
PriceID
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceLivemode
-
PriceLookupKey
-
PriceNickname
-
PriceProductId
-
PriceRecurringAggregateUsage
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringTrialPeriodDays
-
PriceRecurringUsageType
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
Proration
-
Quantity
-
SubscriptionId
-
TaxRates
-
UnitAmount
-
UnitAmountDecimal
Visit documentation for more information.
Retrieve an Invoice Line Items
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
InvoiceItemId
-
SubscriptionId
-
Object
-
Amount
-
AmountDecimal
-
Currency
-
Description
-
DiscountAmounts
-
Discounts
-
Discountable
-
Livemode
-
PeriodEnd
-
PeriodStart
-
Plan
-
PriceID
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceLivemode
-
PriceLookupKey
-
PriceNickname
-
PriceProductId
-
PriceRecurringTrialPeriodDays
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
Proration
-
Quantity
-
TaxAmounts
-
TaxRates
-
Type
Visit documentation for more information.
Retrieve an Upcoming Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Subscription Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
Id
-
LinesObject
-
LinesObject
-
LinesTotalCount
-
LinesUrl
-
AccountCountry
-
AccountName
-
AccountTaxIds
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
BillingReason
-
Charge
-
CollectionMethod
-
CreatedAt
-
CustomFields
-
Customer
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerAddressState
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
CustomerTaxExempt
-
DefaultPaymentMethod
-
DefaultSoure
-
Description
-
Discount
-
DueDate
-
EndingBalance
-
Footer
-
LastFinalizationError
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrePaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDescriptor
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
Subscription
-
Subtotal
-
Tax
-
Total
-
TransferData
-
WebHooksDeliveredAt
-
Object
-
Amount
-
AmountDecimal
-
Currency
-
Description
-
DiscountAmounts
-
Discountable
-
Discounts
-
LiveMode
-
PeriodEnd
-
PeriodStart
-
PlanId
-
PlanObject
-
PlanActive
-
PlanAggregateUsage
-
PlanAmount
-
PlanAmountDecimal
-
PlanBillingScheme
-
PlanCreated
-
PlanCurrency
-
PlanInterval
-
PlanIntervalCount
-
PlanLiveMode
-
PlanNickname
-
PlanProductId
-
PlanTiersMode
-
PlanTransformUsage
-
PlanTrialPeriodDays
-
PlanUsageType
-
PriceId
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceLiveMode
-
PriceLookupKey
-
PriceNickname
-
PriceProductId
-
PriceRecurringAggregateUsage
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringTrialPeriodDays
-
PriceRecurringUsageType
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
Proration
-
Quantityp
-
SubscriptionId
-
SubscriptionItem
-
TaxAmounts
-
TaxRates
-
Type
Visit documentation for more information.
Retrieve an Upcoming Invoice Line Items
Description
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.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Subscription Id
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
URL
-
Id
-
Object
-
Amount
-
Currency
-
Description
-
DiscountAmounts
-
Discountable
-
Discounts
-
LiveMode
-
PeriodEnd
-
PeriodStart
-
PlanID
-
PlanObject
-
PlanActive
-
PlanAggregateUsage
-
PlanAmount
-
PlanAmountDecimal
-
PlanBillingScheme
-
PlanCreated
-
PlanCurrency
-
PlanInterval
-
PlanIntervalCount
-
PlanLivemode
-
PlanNickname
-
PlanProductId
-
PlanTiersMode
-
PlanTransformUsage
-
PlanTrialPeriodDays
-
PlanUsageType
-
PriceID
-
PriceObject
-
PriceActive
-
PriceBillingScheme
-
PriceCreated
-
PriceCurrency
-
PriceLivemode
-
PriceLookupKey
-
PriceNickname
-
PriceProductId
-
PriceRecurringAggregateUsage
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringTrialPeriodDays
-
PriceRecurringUsageType
-
PriceTiersMode
-
PriceTransformQuantity
-
PriceType
-
PriceUnitAmount
-
PriceUnitAmountDecimal
-
Proration
-
Quantity
-
SubscriptionId
-
SubscriptionItem
-
TaxAmounts
-
TaxRates
-
Type
Visit documentation for more information.
Send an Invoice For Manual Payment
Description
Send an Invoice For Manual Payment.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Test Connection
Description
Tests connection.
Parameters
You can provide the following parameters to this action:
-
N/A
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Update a Customer
Description
Updates the specified customer by setting the values of the parameters passed.
Parameters
You can provide the following parameters to this action:
-
Customer Id
-
Name
-
Description
-
Email
-
Payment Method
-
Phone
-
Balance (Enter a numeric Value)
-
Coupon
-
Preferred Locales
-
Promotion Code
-
Tax Id Type (ae_trn, au_abn, br_cnpj, br_cpf etc.)
-
Tax Id Value
-
Address Line1
-
Address Line2
-
Address City
-
Address State
-
Address Country
-
Address Postal Code
-
Shipping Name
-
Shipping Phone
-
Shipping Address Line1
-
Shipping Address Line2
-
Shipping Address City
-
Shipping Address State
-
Shipping Address Country
-
Shipping Address Postal Code
-
Invoice_Prefix (Must be 3–12 uppercase letters or numbers)
-
Invoice Settings - Default Payment Method
-
Invoice Settings - Footer
-
next_invoice_sequence
-
Tax Exempt (none, exempt, reverse)
Input Fields
You can provide the following fields to this action:
-
Id
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
Balance
-
Coupon
-
tax_id_data_type
-
tax_id_data_value
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
Name
-
Email
-
Description
-
Phone
-
PaymentMethod
-
DefaultSource
-
DefaultCurrency
-
Balance
-
Coupon
-
PreferredLocales
-
PromotionCode
-
AddressLine1
-
AddressLine2
-
AddressCity
-
AddressState
-
AddressCountry
-
AddressPostalCode
-
ShippingName
-
ShippingPhone
-
ShippingAddressLine1
-
ShippingAddressLine2
-
ShippingAddressCity
-
ShippingAddressCountry
-
ShippingAddressState
-
ShippingAddressPostalCode
-
TaxIDType
-
TaxIDValue
-
InvoicePrefix
-
InvoiceSettingsDefaultPaymentMethod
-
InvoiceSettingsFooter
-
NextInvoiceSequence
-
TaxExempt
-
Created
-
LiveMode
-
Metadata
Visit documentation for more information.
Update a Product
Description
Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
Parameters
You can provide the following parameters to this action:
-
Product Id
-
Name
-
Type (Good or Service)
-
Active
-
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)
-
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
Input Fields
You can provide the following fields to this action:
-
Id
-
Name
-
Caption
-
Description
-
Type
-
Active
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Shippable
-
Image1
-
Image2
-
Image3
-
Image4
-
Image5
-
Image6
-
Image7
-
Image8
Output Fields
The following fields are returned after calling this action:
-
Id
-
Name
-
Caption
-
Description
-
Active
-
Created
-
Updated
-
Type
-
Object
-
Attributes
-
LiveMode
-
StatementDescription
-
UnitLabel
-
PackageDimensionsHeight
-
PackageDimensionsLength
-
PackageDimensionsWidth
-
PackageDimensionsWeight
-
URL
-
Images
-
TaxCodeId
-
TaxCodeName
-
PriceUnitAmount
-
PriceRecurringInterval
-
PriceRecurringIntervalCount
-
PriceRecurringUsageType
-
Shippable
-
DeactivatedOn
Visit documentation for more information.
Update an Invoice
Description
Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
-
Auto Advance
-
Collection Method (charge_automatically or send_invoice)
-
Description
-
Account Tax Id
-
Application Fee Amount
-
Days Until Due (Can be set if Collection Method = send_invoice)
-
Default Payment Method Id
-
Default Source
-
Default Tax Rates
-
Discounts Coupon Id
-
Discounts Discount Id
-
Due Date
-
Footer
-
Statement Desctiption
-
Transfer Data Destination Id
-
Transfer Data Amount
Input Fields
You can provide the following fields to this action:
-
Id
-
AutoAdvance
-
CollectionMethod
-
Description
-
AccountTaxId
-
ApplicationFeeAmount
-
DaysUntilDue
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Discounts Coupon Id
-
Discounts Discount Id
-
DueDate
-
Footer
-
StatementDesctiption
-
TransferDataDestination
-
TransferDataAmount
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Update an Invoice Item
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Item Id
-
Amount
-
Description
-
Period Start
-
Period End
-
Price Id
-
Discountable
-
Discounts Coupon Id
-
Discounts Discount Id
-
Price Data Currency
-
Price Data Product
-
Price Data Unit Amount Decimal
-
Price Data Unit Amount
-
Quantity
-
Tax Rates
-
Unit Amount Decimal
-
Unit Amount
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Void an Invoice
Description
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.
Parameters
You can provide the following parameters to this action:
-
Invoice Id
Input Fields
You can provide the following fields to this action:
-
Id
Output Fields
The following fields are returned after calling this action:
-
Id
-
Object
-
AccountCountry
-
AccountName
-
AccountTaxId
-
AmountDue
-
AmountPaid
-
AmountRemaining
-
ApplicationFeeAmount
-
AttemptCount
-
Attempted
-
AutoAdvance
-
BillingReason
-
Charge
-
CollectionMethod
-
Created
-
Currency
-
CustomFields
-
CustomerId
-
CustomerAddressCity
-
CustomerAddressCountry
-
CustomerAddressLine1
-
CustomerAddressLine2
-
CustomerAddressPostalCode
-
CustomerAddressState
-
CustomerEmail
-
CustomerName
-
CustomerPhone
-
CustomerShippingAddressCity
-
CustomerShippingAddressCountry
-
CustomerShippingAddressLine1
-
CustomerShippingAddressLine2
-
CustomerShippingAddressPostalCode
-
CustomerShippingAddressState
-
CustomerShippingName
-
CustomerShippingPhone
-
TaxExempt
-
TaxIDs
-
DefaultPaymentMethod
-
DefaultSource
-
DefaultTaxRates
-
Description
-
Discount
-
Discounts
-
DueDate
-
EndingBalance
-
Footer
-
HostedInvoiceURL
-
InvoicePDF
-
LastFinalizationError
-
LinesObject
-
LinesData
-
LinesHasMore
-
LinesTotalCount
-
LinesUrl
-
LiveMode
-
NextPaymentAttempt
-
Number
-
Paid
-
PaymentIntent
-
PeriodEnd
-
PeriodStart
-
PostPaymentCreditNotesAmount
-
PrepaymentCreditNotesAmount
-
ReceiptNumber
-
StartingBalance
-
StatementDesctiption
-
Status
-
StatusTransitionsFinalizedAt
-
StatusTransitionsMarkedUncollectibleAt
-
StatusTransitionsPaidAt
-
StatusTransitionsVoidedAt
-
SubscriptionId
-
Subtotal
-
Tax
-
Total
-
TotalDiscountAmounts
-
TotalTaxAmounts
-
TransferData
-
WebhooksDeliveredAt
Visit documentation for more information.
Make Generic API Request
Description
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.
Parameters
You can provide the following parameters to this action:
-
Url
-
Body
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Make Generic API Request (Bulk Write)
Description
This is a generic endpoint for bulk write purpose. 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.
Parameters
You can provide the following parameters to this action:
-
Url
-
IsMultiPart
-
Filter
-
Headers
Input Fields
You can provide the following fields to this action:
-
N/A
Output Fields
The following fields are returned after calling this action:
-
N/A
Visit documentation for more information.
Conclusion
In this article we showed you how to connect to Stripe in Azure Data Factory (SSIS) and integrate data without any coding, saving you time and effort.
We encourage you to download Stripe Connector for Azure Data Factory (SSIS) and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Stripe Connector for Azure Data Factory (SSIS) Documentation