Reference

Endpoint Pay an Invoice

Name

pay_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. [API reference]

Parameters

Parameter Required Options
Name: Id

Label: Invoice Id

Pay an invoice for the Invoice Id. 		YES
Name: forgive

Label: Forgive
Option Value
False False
True True
Name: off_session

Label: Off Season

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).
Option Value
False False
True True
Name: paid_out_of_band

Label: Paid Out Of Band

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made.
Option Value
False False
True True
Name: payment_method

Label: Payment Method Id

A PaymentMethod to be charged. The PaymentMethod must be the Id of a PaymentMethod belonging to the customer associated with the invoice being paid.
Name: source

Label: Source Id

A payment source to be charged. The source must be the Id of a source belonging to the customer associated with the invoice being paid.

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(255) 255
Object DT_WSTR nvarchar(100) 100
AccountCountry DT_WSTR nvarchar(100) 100
AccountName DT_WSTR nvarchar(1020) 1020
AccountTaxId DT_WSTR nvarchar(1020) 1020
AmountDue DT_I8 bigint
AmountPaid DT_I8 bigint
AmountRemaining DT_I8 bigint
ApplicationFeeAmount DT_I8 bigint
AttemptCount DT_I8 bigint
Attempted DT_BOOL bit
AutoAdvance DT_BOOL bit
BillingReason DT_WSTR nvarchar(1020) 1020
Charge DT_WSTR nvarchar(255) 255
CollectionMethod DT_WSTR nvarchar(1020) 1020
Created DT_DBTIMESTAMP datetime
Currency DT_WSTR nvarchar(100) 100
CustomFields DT_WSTR nvarchar(1020) 1020
CustomerId DT_WSTR nvarchar(1020) 1020
CustomerAddressCity DT_WSTR nvarchar(1020) 1020
CustomerAddressCountry DT_WSTR nvarchar(1020) 1020
CustomerAddressLine1 DT_WSTR nvarchar(1020) 1020
CustomerAddressLine2 DT_WSTR nvarchar(1020) 1020
CustomerAddressPostalCode DT_WSTR nvarchar(1020) 1020
CustomerAddressState DT_WSTR nvarchar(1020) 1020
CustomerEmail DT_WSTR nvarchar(100) 100
CustomerName DT_WSTR nvarchar(100) 100
CustomerPhone DT_WSTR nvarchar(100) 100
CustomerShippingAddressCity DT_WSTR nvarchar(100) 100
CustomerShippingAddressCountry DT_WSTR nvarchar(100) 100
CustomerShippingAddressLine1 DT_WSTR nvarchar(100) 100
CustomerShippingAddressLine2 DT_WSTR nvarchar(100) 100
CustomerShippingAddressPostalCode DT_WSTR nvarchar(100) 100
CustomerShippingAddressState DT_WSTR nvarchar(100) 100
CustomerShippingName DT_WSTR nvarchar(100) 100
CustomerShippingPhone DT_WSTR nvarchar(100) 100
TaxExempt DT_WSTR nvarchar(100) 100
TaxIDs DT_WSTR nvarchar(1020) 1020
DefaultPaymentMethod DT_WSTR nvarchar(1020) 1020
DefaultSource DT_WSTR nvarchar(1020) 1020
DefaultTaxRates DT_WSTR nvarchar(1000) 1000
Description DT_WSTR nvarchar(1020) 1020
Discount DT_WSTR nvarchar(1020) 1020
Discounts DT_WSTR nvarchar(100) 100
DueDate DT_DBTIMESTAMP datetime
EndingBalance DT_I8 bigint
Footer DT_WSTR nvarchar(1020) 1020
HostedInvoiceURL DT_WSTR nvarchar(1020) 1020
InvoicePDF DT_WSTR nvarchar(1020) 1020
LastFinalizationError DT_WSTR nvarchar(1020) 1020
LinesObject DT_WSTR nvarchar(100) 100
LinesData DT_NTEXT nvarchar(MAX)
LinesHasMore DT_BOOL bit
LinesTotalCount DT_I8 bigint
LinesUrl DT_WSTR nvarchar(1020) 1020
LiveMode DT_BOOL bit
NextPaymentAttempt DT_DBTIMESTAMP datetime
Number DT_WSTR nvarchar(1020) 1020
Paid DT_BOOL bit
PaymentIntent DT_WSTR nvarchar(1020) 1020
PeriodEnd DT_DBTIMESTAMP datetime
PeriodStart DT_DBTIMESTAMP datetime
PostPaymentCreditNotesAmount DT_I8 bigint
PrepaymentCreditNotesAmount DT_I8 bigint
ReceiptNumber DT_WSTR nvarchar(255) 255
StartingBalance DT_I8 bigint
StatementDesctiption DT_WSTR nvarchar(1020) 1020
Status DT_WSTR nvarchar(100) 100
StatusTransitionsFinalizedAt DT_DBTIMESTAMP datetime
StatusTransitionsMarkedUncollectibleAt DT_DBTIMESTAMP datetime
StatusTransitionsPaidAt DT_DBTIMESTAMP datetime
StatusTransitionsVoidedAt DT_DBTIMESTAMP datetime
SubscriptionId DT_WSTR nvarchar(1020) 1020
Subtotal DT_I8 bigint
Tax DT_I8 bigint
Total DT_I8 bigint
TotalDiscountAmounts DT_WSTR nvarchar(100) 100
TotalTaxAmounts DT_WSTR nvarchar(100) 100
TransferData DT_WSTR nvarchar(1020) 1020
WebhooksDeliveredAt DT_DBTIMESTAMP datetime
If the column you are looking for is missing, consider customizing Stripe Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
Id DT_WSTR nvarchar(4000) 4000
Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

API Source - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Pay an Invoice
Required Parameters
Invoice Id Fill-in the parameter...
Optional Parameters
Forgive
Off Season
Paid Out Of Band
Payment Method Id
Source Id
SSIS API Source - Read from table or endpoint

API Destination

API Destination - Stripe
This connector support read/write operations for Stripe APIs
Stripe
Pay an Invoice
Required Parameters
Invoice Id Fill-in the parameter...
Optional Parameters
Forgive
Off Season
Paid Out Of Band
Payment Method Id
Source Id
SSIS API Destination - Access table or endpoint

ODBC application

Use these SQL queries in your ODBC application data source:

Pay an invoice 

SELECT * FROM pay_invoice
WHERE Id = 'abcd-1234-id'

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Pay an invoice 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM pay_invoice
WHERE Id = ''abcd-1234-id''';

EXEC (@MyQuery) AT [LS_TO_STRIPE_IN_GATEWAY];