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

Label

Required

Options

Description

Invoice Id

YES

Pay an invoice for the Invoice Id.

forgive

Forgive

Option	Value
False	False
True	True

off_session

Off Season

Option	Value
False	False
True	True

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to true (off-session).

paid_out_of_band

Paid Out Of Band

Option	Value
False	False
True	True

Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made.

payment_method

Payment Method Id

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

source

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	Raw
Id	`DT_WSTR`	`nvarchar(255)`	255	`False`
Object	`DT_WSTR`	`nvarchar(100)`	100	`False`
AccountCountry	`DT_WSTR`	`nvarchar(100)`	100	`False`
AccountName	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
AccountTaxId	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
AmountDue	`DT_I8`	`bigint`		`False`
AmountPaid	`DT_I8`	`bigint`		`False`
AmountRemaining	`DT_I8`	`bigint`		`False`
ApplicationFeeAmount	`DT_I8`	`bigint`		`False`
AttemptCount	`DT_I8`	`bigint`		`False`
Attempted	`DT_BOOL`	`bit`		`False`
AutoAdvance	`DT_BOOL`	`bit`		`False`
BillingReason	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Charge	`DT_WSTR`	`nvarchar(255)`	255	`False`
CollectionMethod	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Created	`DT_DBTIMESTAMP`	`datetime`		`False`
Currency	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomFields	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerId	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressCity	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressCountry	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressLine1	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressLine2	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressPostalCode	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerAddressState	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
CustomerEmail	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerName	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerPhone	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressCity	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressCountry	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressLine1	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressLine2	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressPostalCode	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingAddressState	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingName	`DT_WSTR`	`nvarchar(100)`	100	`False`
CustomerShippingPhone	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxExempt	`DT_WSTR`	`nvarchar(100)`	100	`False`
TaxIDs	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
DefaultPaymentMethod	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
DefaultSource	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
DefaultTaxRates	`DT_WSTR`	`nvarchar(1000)`	1000	`False`
Description	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Discount	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Discounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
DueDate	`DT_DBTIMESTAMP`	`datetime`		`False`
EndingBalance	`DT_I8`	`bigint`		`False`
Footer	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
HostedInvoiceURL	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
InvoicePDF	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
LastFinalizationError	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
LinesObject	`DT_WSTR`	`nvarchar(100)`	100	`False`
LinesData	`DT_NTEXT`	`nvarchar(MAX)`		`False`
LinesHasMore	`DT_BOOL`	`bit`		`False`
LinesTotalCount	`DT_I8`	`bigint`		`False`
LinesUrl	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
LiveMode	`DT_BOOL`	`bit`		`False`
NextPaymentAttempt	`DT_DBTIMESTAMP`	`datetime`		`False`
Number	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Paid	`DT_BOOL`	`bit`		`False`
PaymentIntent	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
PeriodEnd	`DT_DBTIMESTAMP`	`datetime`		`False`
PeriodStart	`DT_DBTIMESTAMP`	`datetime`		`False`
PostPaymentCreditNotesAmount	`DT_I8`	`bigint`		`False`
PrepaymentCreditNotesAmount	`DT_I8`	`bigint`		`False`
ReceiptNumber	`DT_WSTR`	`nvarchar(255)`	255	`False`
StartingBalance	`DT_I8`	`bigint`		`False`
StatementDesctiption	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Status	`DT_WSTR`	`nvarchar(100)`	100	`False`
StatusTransitionsFinalizedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
StatusTransitionsMarkedUncollectibleAt	`DT_DBTIMESTAMP`	`datetime`		`False`
StatusTransitionsPaidAt	`DT_DBTIMESTAMP`	`datetime`		`False`
StatusTransitionsVoidedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
SubscriptionId	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
Subtotal	`DT_I8`	`bigint`		`False`
Tax	`DT_I8`	`bigint`		`False`
Total	`DT_I8`	`bigint`		`False`
TotalDiscountAmounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
TotalTaxAmounts	`DT_WSTR`	`nvarchar(100)`	100	`False`
TransferData	`DT_WSTR`	`nvarchar(1020)`	1020	`False`
WebhooksDeliveredAt	`DT_DBTIMESTAMP`	`datetime`		`False`

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
Id	`DT_WSTR`	`nvarchar(4000)`	4000	`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Stripe Connector in API Source component to read data or in API Destination component to read/write data:

Pay an Invoice using API Source

Stripe

Pay an Invoice

SSIS API Source - Read from table or endpoint

Pay an Invoice using API Destination

Stripe

Pay an Invoice