Stripe Connector
The high-performance Stripe Connector provides read/write capabilities within your application, allowing you to perform numerous Stripe operations with minimal coding or even no-coding at all. Integrate Stripe data into applications such as SSIS, SQL Server, any ODBC-compatible application, or even directly within a programming language using this connector.
Download for SSIS Download for SQL Server and ODBC Documentation
Integrate Stripe with these applications
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.