Stripe connection for LinkyFlow

Stripe connection for LinkyFlow

LinkyFlow brings Stripe ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

58

Read requests

34

Write actions

71

Documented fields

267

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Billing

Accept Quote

Accepts on the customer’s behalf. Creates whatever the quote describes — an invoice, a subscription, or both.

Create

Accept Quote

Accept Quote

Route: POST /mutation/quoteAccept

Inputs you can set
NameTypeRequiredDescription
quote_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Quote

Withdraws the quote. It can no longer be accepted.

Create

Cancel Quote

Cancel Quote

Route: POST /mutation/quoteCancel

Inputs you can set
NameTypeRequiredDescription
quote_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Subscription Schedule

Cancels the schedule and the subscription it drives.

Create

Cancel Subscription Schedule

Cancel Subscription Schedule

Route: POST /mutation/subscriptionScheduleCancel

Inputs you can set
NameTypeRequiredDescription
invoice_nowbooleanNo-
proratebooleanNo-
schedule_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Coupons

Discount coupons.

Read

Coupons

Discount coupons.

Route: GET /coupons

Excel formula: =LF.stripe.coupons("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount_off
default

number

-

created
default

date

-

duration
default

enum

-

id
default

id

-

name
default

string

-

percent_off
default

number

-

times_redeemed
default

number

-

Create

Create Coupon

Create Coupon

Route: POST /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amount_offnumberNo-
currencystringNo-
durationenumYesValues: forever, once, repeating
duration_in_monthsnumberNo-
namestringNo-
percent_offnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Coupon

Update Coupon

Route: PATCH /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amount_offnumberNo-
currencystringNo-
durationenumYesValues: forever, once, repeating
duration_in_monthsnumberNo-
namestringNo-
percent_offnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Coupon

Delete Coupon

Route: DELETE /mutation/coupons

Inputs you can set
NameTypeRequiredDescription
amount_offnumberNo-
currencystringNo-
durationenumYesValues: forever, once, repeating
duration_in_monthsnumberNo-
namestringNo-
percent_offnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Credit Note Preview

What a credit note would do to an invoice, without creating one.

Read

Credit Note Preview

What a credit note would do to an invoice, without creating one.

Route: GET /creditNotesPreview

Excel formula: =LF.stripe.creditNotesPreview("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
invoiceidYes-
amountnumberNoAmount in the smallest currency unit (e.g. cents).
reasonenumNoValues: duplicate, fraudulent, order_change, product_unsatisfactory
refund_amountnumberNoAmount in the smallest currency unit (e.g. cents).
credit_amountnumberNoAmount in the smallest currency unit (e.g. cents).
out_of_band_amountnumberNoAmount in the smallest currency unit (e.g. cents).
linesstringNo-
Data returned in Excel
Field
Type
Relations
Description
amount

number

-

currency
default

string

-

invoice
default

id

-

subtotal

number

-

total
default

number

-

Credit Notes

Credit notes adjusting finalised invoices — a refund, a customer credit, or neither.

Read

Credit Notes

Credit notes adjusting finalised invoices — a refund, a customer credit, or neither.

Route: GET /creditNotes

Excel formula: =LF.stripe.creditNotes("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
invoiceidNoOnly credit notes against this invoice
customeridNoFilter by customer
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
created
default

date

-

currency
default

string

-

id
default

id

-

invoice
default

id

-

number
default

string

-

status
default

enum

-

total
default

number

-

Create

Create Credit Note

Create Credit Note

Route: POST /mutation/creditNotes

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
credit_amountnumberNo-
invoiceidYes-
linesstringNo-
memostringNo-
out_of_band_amountnumberNo-
reasonenumNoValues: duplicate, fraudulent, order_change, product_unsatisfactory
refund_amountnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customer Portal Session

A short-lived link letting one customer manage their own subscriptions, payment methods and invoices.

Create

Create Portal Session

Create Portal Session

Route: POST /mutation/billingPortalSessions

Inputs you can set
NameTypeRequiredDescription
configurationidNo-
customeridYes-
localestringNo-
on_behalf_ofidNo-
return_urlstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customers

Customers in your Stripe account.

Read

Customers

Customers in your Stripe account.

Route: GET /customers

Excel formula: =LF.stripe.customers("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
emailstringNoFilter by exact email
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
balance

number

-

created
default

date

-

currency

string

-

delinquent

boolean

-

description

string

-

email
default

string

-

id
default

id

-

name
default

string

-

phone

string

-

Create

Create Customer

Create Customer

Route: POST /mutation/customers

Inputs you can set
NameTypeRequiredDescription
currencystringNo-
descriptionstringNo-
emailstringNo-
metadata.linkyflow_external_referencestringNo-
namestringNo-
phonestringNo-
preferred_localesstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer

Update Customer

Route: PATCH /mutation/customers

Inputs you can set
NameTypeRequiredDescription
currencystringNo-
descriptionstringNo-
emailstringNo-
metadata.linkyflow_external_referencestringNo-
namestringNo-
phonestringNo-
preferred_localesstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer

Delete Customer

Route: DELETE /mutation/customers

Inputs you can set
NameTypeRequiredDescription
currencystringNo-
descriptionstringNo-
emailstringNo-
metadata.linkyflow_external_referencestringNo-
namestringNo-
phonestringNo-
preferred_localesstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Finalize Invoice

Turns a draft into an issued invoice. Numbers it, freezes most of it, and may email the customer.

Create

Finalize Invoice

Finalize Invoice

Route: POST /mutation/invoiceFinalize

Inputs you can set
NameTypeRequiredDescription
auto_advancebooleanNo-
invoice_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Finalize Quote

Issues the quote so the customer can accept it.

Create

Finalize Quote

Finalize Quote

Route: POST /mutation/quoteFinalize

Inputs you can set
NameTypeRequiredDescription
expires_atnumberNo-
quote_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoice Items

Pending line items added to a customer’s next invoice.

Read

Invoice Items

Pending line items added to a customer’s next invoice.

Route: GET /invoiceItems

Excel formula: =LF.stripe.invoiceItems("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

created
default

date

-

currency
default

string

-

customer
default

id

customers

-

description
default

string

-

id
default

id

-

Create

Create Invoice Item

Create Invoice Item

Route: POST /mutation/invoiceItems

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
currencystringNo-
customeridNo-
descriptionstringNo-
invoiceidNo-
priceidNo-
quantitynumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Invoice Item

Update Invoice Item

Route: PATCH /mutation/invoiceItems

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
currencystringNo-
customeridNo-
descriptionstringNo-
invoiceidNo-
priceidNo-
quantitynumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Invoice Item

Delete Invoice Item

Route: DELETE /mutation/invoiceItems

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
currencystringNo-
customeridNo-
descriptionstringNo-
invoiceidNo-
priceidNo-
quantitynumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoices

Invoices issued to customers.

Read

Invoices

Invoices issued to customers.

Route: GET /invoices

Excel formula: =LF.stripe.invoices("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
statusenumNoFilter by status Values: draft, open, paid, uncollectible, void
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount_due
default

number

-

created
default

date

-

customer
default

id

customers

-

id
default

id

-

number
default

string

-

status
default

enum

-

total
default

number

-

Create

Create Invoice

Create Invoice

Route: POST /mutation/invoices

Inputs you can set
NameTypeRequiredDescription
auto_advancebooleanNo-
automatic_tax.enabledbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
currencystringNo-
customeridYes-
days_until_duenumberNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Invoice

Update Invoice

Route: PATCH /mutation/invoices

Inputs you can set
NameTypeRequiredDescription
auto_advancebooleanNo-
automatic_tax.enabledbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
currencystringNo-
customeridYes-
days_until_duenumberNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Draft Invoice

Delete Draft Invoice

Route: DELETE /mutation/invoices

Inputs you can set
NameTypeRequiredDescription
auto_advancebooleanNo-
automatic_tax.enabledbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
currencystringNo-
customeridYes-
days_until_duenumberNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Mark Invoice Uncollectible

Writes the invoice off as bad debt. An accounting statement, not a cancellation.

Create

Mark Invoice Uncollectible

Mark Invoice Uncollectible

Route: POST /mutation/invoiceMarkUncollectible

Inputs you can set
NameTypeRequiredDescription
invoice_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Meter Event Adjustments

Cancels a usage event already reported, by its identifier.

Create

Cancel Usage Event

Cancel Usage Event

Route: POST /mutation/meterEventAdjustments

Inputs you can set
NameTypeRequiredDescription
cancel.identifierstringYes-
event_namestringYes-
typeenumYesValues: cancel
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Meter Event Summaries

Usage a meter has aggregated for one customer over a window.

Read

Meter Event Summaries

Usage a meter has aggregated for one customer over a window.

Route: GET /meterEventSummaries

Excel formula: =LF.stripe.meterEventSummaries("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
meter_ididYes-
customeridYes-
start_timenumberYesEpoch seconds
end_timenumberYesEpoch seconds
value_grouping_windowenumNoValues: day, hour
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
aggregated_value
default

number

-

end_time
default

date

-

id
default

id

-

meter
default

id

-

start_time
default

date

-

Meter Events

Reports one unit of usage. Stripe aggregates asynchronously, so it will not appear immediately.

Create

Record Usage

Record Usage

Route: POST /mutation/meterEvents

Inputs you can set
NameTypeRequiredDescription
event_namestringYes-
identifierstringNo-
payload.stripe_customer_ididYes-
payload.valuestringYes-
timestampnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Meters

Meters aggregating usage events, for prices billed on what a customer actually used.

Read

Meters

Meters aggregating usage events, for prices billed on what a customer actually used.

Route: GET /meters

Excel formula: =LF.stripe.meters("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
statusenumNoValues: active, inactive
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
created
default

date

-

default_aggregation
default

string

-

display_name
default

string

-

event_name
default

string

-

id
default

id

-

status
default

enum

-

Create

Create Meter

Create Meter

Route: POST /mutation/meters

Inputs you can set
NameTypeRequiredDescription
customer_mapping.event_payload_keystringNo-
customer_mapping.typeenumNoValues: by_id
default_aggregation.formulaenumNoValues: sum, count
display_namestringYes-
event_namestringYes-
value_settings.event_payload_keystringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Meter

Update Meter

Route: PATCH /mutation/meters

Inputs you can set
NameTypeRequiredDescription
customer_mapping.event_payload_keystringNo-
customer_mapping.typeenumNoValues: by_id
default_aggregation.formulaenumNoValues: sum, count
display_namestringYes-
event_namestringYes-
value_settings.event_payload_keystringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Pause Subscription

Stops collecting on a subscription without cancelling it.

Edit

Pause Subscription

Pause Subscription

Route: PATCH /mutation/subscriptionPause

Inputs you can set
NameTypeRequiredDescription
ididYes-
pause_collection.behaviorenumNoValues: keep_as_draft, mark_uncollectible, void
pause_collection.resumes_atnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Pay Invoice

Attempts payment with the customer’s saved method, or records one taken outside Stripe.

Create

Pay Invoice

Pay Invoice

Route: POST /mutation/invoicePay

Inputs you can set
NameTypeRequiredDescription
forgivebooleanNo-
invoice_ididYes-
paid_out_of_bandbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Promotion Codes

Customer-facing codes that apply a coupon.

Read

Promotion Codes

Customer-facing codes that apply a coupon.

Route: GET /promotionCodes

Excel formula: =LF.stripe.promotionCodes("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
codestringNoFilter by code
activebooleanNoFilter by active state
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
active
default

boolean

-

code
default

string

-

coupon
default

id

-

created
default

date

-

id
default

id

-

times_redeemed
default

number

-

Create

Create Promotion Code

Create Promotion Code

Route: POST /mutation/promotionCodes

Inputs you can set
NameTypeRequiredDescription
codestringNo-
couponidYes-
customeridNo-
expires_atnumberNo-
max_redemptionsnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Promotion Code

Update Promotion Code

Route: PATCH /mutation/promotionCodes

Inputs you can set
NameTypeRequiredDescription
codestringNo-
couponidYes-
customeridNo-
expires_atnumberNo-
max_redemptionsnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Quotes

Quotes a customer can accept, which then create an invoice or a subscription.

Read

Quotes

Quotes a customer can accept, which then create an invoice or a subscription.

Route: GET /quotes

Excel formula: =LF.stripe.quotes("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
statusenumNoValues: draft, open, accepted, canceled
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount_total
default

number

-

created
default

date

-

currency
default

string

-

customer
default

id

customers

-

id
default

id

-

number
default

string

-

status
default

enum

-

Create

Create Quote

Create Quote

Route: POST /mutation/quotes

Inputs you can set
NameTypeRequiredDescription
collection_methodenumNoValues: charge_automatically, send_invoice
customeridNo-
descriptionstringNo-
expires_atnumberNo-
footerstringNo-
headerstringNo-
line_itemsstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Quote

Update Quote

Route: PATCH /mutation/quotes

Inputs you can set
NameTypeRequiredDescription
collection_methodenumNoValues: charge_automatically, send_invoice
customeridNo-
descriptionstringNo-
expires_atnumberNo-
footerstringNo-
headerstringNo-
line_itemsstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Release Subscription Schedule

Detaches the schedule. The subscription keeps running, unmanaged.

Create

Release Subscription Schedule

Release Subscription Schedule

Route: POST /mutation/subscriptionScheduleRelease

Inputs you can set
NameTypeRequiredDescription
schedule_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Resume Subscription

Restarts a paused subscription.

Create

Resume Subscription

Resume Subscription

Route: POST /mutation/subscriptionResume

Inputs you can set
NameTypeRequiredDescription
billing_cycle_anchorenumNoValues: now, unchanged
proration_behaviorenumNoValues: create_prorations, none, always_invoice
subscription_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Invoice

Emails the invoice to the customer. Stripe sends the mail.

Create

Send Invoice

Send Invoice

Route: POST /mutation/invoiceSend

Inputs you can set
NameTypeRequiredDescription
invoice_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Subscription Change Preview

What changing a subscription would cost — the proration, before it is applied.

Read

Subscription Change Preview

What changing a subscription would cost — the proration, before it is applied.

Route: GET /subscriptionsUpcoming

Excel formula: =LF.stripe.subscriptionsUpcoming("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
subscriptionidYes-
subscription_itemsstringNo-
subscription_proration_behaviorenumNoValues: create_prorations, none, always_invoice
Data returned in Excel
Field
Type
Relations
Description
amount_due
default

number

-

currency
default

string

-

lines
default

string

-

period_end

date

-

period_start

date

-

subtotal

number

-

total
default

number

-

Subscription Schedules

Subscriptions planned in phases — a trial, then one price, then another.

Read

Subscription Schedules

Subscriptions planned in phases — a trial, then one price, then another.

Route: GET /subscriptionSchedules

Excel formula: =LF.stripe.subscriptionSchedules("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
scheduledbooleanNoOnly schedules that have not started
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
created
default

date

-

customer
default

id

customers

-

id
default

id

-

phases
default

string

-

status
default

enum

-

subscription
default

id

-

Create

Create Subscription Schedule

Create Subscription Schedule

Route: POST /mutation/subscriptionSchedules

Inputs you can set
NameTypeRequiredDescription
customeridNo-
end_behaviorenumNoValues: release, cancel
from_subscriptionidNo-
phasesstringNo-
start_datenumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Subscription Schedule

Update Subscription Schedule

Route: PATCH /mutation/subscriptionSchedules

Inputs you can set
NameTypeRequiredDescription
customeridNo-
end_behaviorenumNoValues: release, cancel
from_subscriptionidNo-
phasesstringNo-
start_datenumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Subscriptions

Recurring subscriptions.

Read

Subscriptions

Recurring subscriptions.

Route: GET /subscriptions

Excel formula: =LF.stripe.subscriptions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
statusenumNoFilter by status Values: active, past_due, unpaid, canceled, incomplete
priceidNoFilter by price
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
cancel_at_period_end
default

boolean

-

created
default

date

-

current_period_end
default

date

-

current_period_start
default

date

-

customer
default

id

customers

-

id
default

id

-

status
default

enum

-

Create

Create Subscription

Create Subscription

Route: POST /mutation/subscriptions

Inputs you can set
NameTypeRequiredDescription
automatic_tax.enabledbooleanNo-
cancel_at_period_endbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
couponidNo-
customeridYes-
days_until_duenumberNo-
items.0.priceidYes-
items.0.quantitynumberNo-
metadata.linkyflow_external_referencestringNo-
promotion_codeidNo-
trial_endnumberNo-
trial_period_daysnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Subscription

Update Subscription

Route: PATCH /mutation/subscriptions

Inputs you can set
NameTypeRequiredDescription
automatic_tax.enabledbooleanNo-
cancel_at_period_endbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
couponidNo-
customeridYes-
days_until_duenumberNo-
items.0.priceidYes-
items.0.quantitynumberNo-
metadata.linkyflow_external_referencestringNo-
promotion_codeidNo-
trial_endnumberNo-
trial_period_daysnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Cancel Subscription

Cancel Subscription

Route: DELETE /mutation/subscriptions

Inputs you can set
NameTypeRequiredDescription
automatic_tax.enabledbooleanNo-
cancel_at_period_endbooleanNo-
collection_methodenumNoValues: charge_automatically, send_invoice
couponidNo-
customeridYes-
days_until_duenumberNo-
items.0.priceidYes-
items.0.quantitynumberNo-
metadata.linkyflow_external_referencestringNo-
promotion_codeidNo-
trial_endnumberNo-
trial_period_daysnumberNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tax Calculation

Works out the tax due on a hypothetical sale. Nothing is recorded and nothing is owed.

Create

Calculate Tax

Calculate Tax

Route: POST /mutation/taxCalculations

Inputs you can set
NameTypeRequiredDescription
currencystringYes-
customeridNo-
customer_details.address.countrystringNo-
customer_details.address.postal_codestringNo-
customer_details.address.statestringNo-
customer_details.address_sourceenumNoValues: billing, shipping
line_itemsstringYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tax Rates

Tax rates applied to invoices and subscriptions.

Read

Tax Rates

Tax rates applied to invoices and subscriptions.

Route: GET /taxRates

Excel formula: =LF.stripe.taxRates("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
activebooleanNoFilter by active state
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
active
default

boolean

-

created
default

date

-

display_name
default

string

-

id
default

id

-

inclusive
default

boolean

-

percentage
default

number

-

Create

Create Tax Rate

Create Tax Rate

Route: POST /mutation/taxRates

Inputs you can set
NameTypeRequiredDescription
countrystringNo-
display_namestringYes-
inclusivebooleanYes-
jurisdictionstringNo-
percentagenumberYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Tax Rate

Update Tax Rate

Route: PATCH /mutation/taxRates

Inputs you can set
NameTypeRequiredDescription
countrystringNo-
display_namestringYes-
inclusivebooleanYes-
jurisdictionstringNo-
percentagenumberYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tax Transactions

Tax actually recorded against a completed sale — what a filing is built from.

Read

Tax Transactions

Tax actually recorded against a completed sale — what a filing is built from.

Route: GET /taxTransactions

Excel formula: =LF.stripe.taxTransactions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
created
default

date

-

currency
default

string

-

customer

id

customers

-

id
default

id

-

reference
default

string

-

type
default

enum

-

Upcoming Invoice

What a customer or subscription would be billed next. Never persisted, and it changes as the period does.

Read

Upcoming Invoice

What a customer or subscription would be billed next. Never persisted, and it changes as the period does.

Route: GET /invoicesUpcoming

Excel formula: =LF.stripe.invoicesUpcoming("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
customeridNoFilter by customer
subscriptionidNoPreview this subscription’s next invoice
subscription_itemsstringNoItems to price as if they were already applied
subscription_proration_behaviorenumNoValues: create_prorations, none, always_invoice
subscription_proration_datenumberNoEpoch seconds the proration is computed at
Data returned in Excel
Field
Type
Relations
Description
amount_due
default

number

-

currency
default

string

-

customer
default

id

customers

-

id
default

id

-

subscription
default

id

-

total
default

number

-

Void Credit Note

Cancels a credit note, putting the invoice balance back where it was.

Create

Void Credit Note

Void Credit Note

Route: POST /mutation/creditNoteVoid

Inputs you can set
NameTypeRequiredDescription
credit_note_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Void Invoice

Cancels a finalised invoice. Irreversible, and the invoice number stays used.

Create

Void Invoice

Void Invoice

Route: POST /mutation/invoiceVoid

Inputs you can set
NameTypeRequiredDescription
invoice_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Catalog

Prices

Prices attached to products.

Read

Prices

Prices attached to products.

Route: GET /prices

Excel formula: =LF.stripe.prices("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
productidNoFilter by product
activebooleanNoFilter by active state
typeenumNoFilter by price type Values: one_time, recurring
currencystringNoFilter by three-letter ISO currency code
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
active
default

boolean

-

created
default

date

-

currency
default

string

-

id
default

id

-

nickname
default

string

-

product
default

id

products

-

type
default

enum

-

unit_amount
default

number

-

Create

Create Price

Create Price

Route: POST /mutation/prices

Inputs you can set
NameTypeRequiredDescription
currencystringYes-
nicknamestringNo-
productidYes-
recurring.intervalenumNoValues: day, week, month, year
recurring.interval_countnumberNo-
recurring.meteridNo-
recurring.usage_typeenumNoValues: licensed, metered
tax_behaviorenumNoValues: inclusive, exclusive, unspecified
typeenumNoValues: one_time, recurring
unit_amountnumberYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Price

Update Price

Route: PATCH /mutation/prices

Inputs you can set
NameTypeRequiredDescription
currencystringYes-
nicknamestringNo-
productidYes-
recurring.intervalenumNoValues: day, week, month, year
recurring.interval_countnumberNo-
recurring.meteridNo-
recurring.usage_typeenumNoValues: licensed, metered
tax_behaviorenumNoValues: inclusive, exclusive, unspecified
typeenumNoValues: one_time, recurring
unit_amountnumberYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Products

Products in your Stripe catalog.

Used as filter by

Read

Products

Products in your Stripe catalog.

Route: GET /products

Excel formula: =LF.stripe.products("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
activebooleanNoFilter by active state
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
active
default

boolean

-

created
default

date

-

default_price
default

id

-

description

string

-

id
default

id

-

name
default

string

-

Create

Create Product

Create Product

Route: POST /mutation/products

Inputs you can set
NameTypeRequiredDescription
activebooleanNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
namestringYes-
statement_descriptorstringNo-
tax_codestringNo-
unit_labelstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Update Product

Route: PATCH /mutation/products

Inputs you can set
NameTypeRequiredDescription
activebooleanNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
namestringYes-
statement_descriptorstringNo-
tax_codestringNo-
unit_labelstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Product

Delete Product

Route: DELETE /mutation/products

Inputs you can set
NameTypeRequiredDescription
activebooleanNo-
descriptionstringNo-
metadata.linkyflow_external_referencestringNo-
namestringYes-
statement_descriptorstringNo-
tax_codestringNo-
unit_labelstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Shipping Rates

Delivery options and their cost, offered at checkout.

Read

Shipping Rates

Delivery options and their cost, offered at checkout.

Route: GET /shippingRates

Excel formula: =LF.stripe.shippingRates("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
activebooleanNo-
currencystringNo-
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
active
default

boolean

-

created
default

date

-

display_name
default

string

-

fixed_amount
default

string

-

id
default

id

-

type
default

enum

-

Create

Create Shipping Rate

Create Shipping Rate

Route: POST /mutation/shippingRates

Inputs you can set
NameTypeRequiredDescription
delivery_estimate.maximum.unitenumNoValues: hour, day, business_day, week, month
delivery_estimate.maximum.valuenumberNo-
delivery_estimate.minimum.unitenumNoValues: hour, day, business_day, week, month
delivery_estimate.minimum.valuenumberNo-
display_namestringYes-
fixed_amount.amountnumberYes-
fixed_amount.currencystringYes-
tax_behaviorenumNoValues: inclusive, exclusive, unspecified
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Shipping Rate

Update Shipping Rate

Route: PATCH /mutation/shippingRates

Inputs you can set
NameTypeRequiredDescription
delivery_estimate.maximum.unitenumNoValues: hour, day, business_day, week, month
delivery_estimate.maximum.valuenumberNo-
delivery_estimate.minimum.unitenumNoValues: hour, day, business_day, week, month
delivery_estimate.minimum.valuenumberNo-
display_namestringYes-
fixed_amount.amountnumberYes-
fixed_amount.currencystringYes-
tax_behaviorenumNoValues: inclusive, exclusive, unspecified
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Connect

Application Fees

Fees the platform collected on connected-account charges.

Read

Application Fees

Fees the platform collected on connected-account charges.

Route: GET /applicationFees

Excel formula: =LF.stripe.applicationFees("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
account
default

id

-

amount
default

number

-

amount_refunded

number

-

created
default

date

-

currency
default

string

-

id
default

id

-

refunded

boolean

-

Connected Account Requirements

What a connected account still owes before it can charge or be paid out.

Read

Connected Account Requirements

What a connected account still owes before it can charge or be paid out.

Route: GET /accountRequirements

Excel formula: =LF.stripe.accountRequirements("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididYes-
Data returned in Excel
Field
Type
Relations
Description
charges_enabled
default

boolean

-

details_submitted

boolean

-

id
default

id

-

payouts_enabled
default

boolean

-

requirements
default

string

-

Connected Accounts

Accounts connected to this platform.

Read

Connected Accounts

Accounts connected to this platform.

Route: GET /accounts

Excel formula: =LF.stripe.accounts("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
charges_enabled
default

boolean

-

country
default

string

-

created
default

date

-

id
default

id

-

payouts_enabled
default

boolean

-

type
default

enum

-

Create

Create Connected Account

Create Connected Account

Route: POST /mutation/accounts

Inputs you can set
NameTypeRequiredDescription
countrystringNo-
emailstringNo-
typeenumNoValues: standard, express, custom
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Connected Account

Update Connected Account

Route: PATCH /mutation/accounts

Inputs you can set
NameTypeRequiredDescription
countrystringNo-
emailstringNo-
typeenumNoValues: standard, express, custom
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transfer Reversals

Pulls a transfer back from a connected account.

Create

Reverse Transfer

Reverse Transfer

Route: POST /mutation/transferReversals

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
refund_application_feebooleanNo-
transfer_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transfers

Money moved from the platform balance to a connected account.

Read

Transfers

Money moved from the platform balance to a connected account.

Route: GET /transfers

Excel formula: =LF.stripe.transfers("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
destinationidNoOnly transfers to this connected account
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

amount_reversed

number

-

created
default

date

-

currency
default

string

-

description

string

-

destination
default

id

-

id
default

id

-

reversed

boolean

-

Create

Create Transfer

Create Transfer

Route: POST /mutation/transfers

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
currencystringYes-
descriptionstringNo-
destinationidYes-
transfer_groupstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Developers

Events

Account activity events.

Read

Events

Account activity events.

Route: GET /events

Excel formula: =LF.stripe.events("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
typestringNoFilter by event type (e.g. invoice.paid)
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
api_version

string

-

created
default

date

-

id
default

id

-

type
default

string

-

Payments

Cancel Payout

Cancels a payout still in transit. An automatic payout usually cannot be cancelled.

Create

Cancel Payout

Cancel Payout

Route: POST /mutation/payoutCancel

Inputs you can set
NameTypeRequiredDescription
payout_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Refund

Cancels a refund that has not left yet. Only refunds in certain states can be.

Create

Cancel Refund

Cancel Refund

Route: POST /mutation/refundCancel

Inputs you can set
NameTypeRequiredDescription
refund_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Charges

Individual charges.

Read

Charges

Individual charges.

Route: GET /charges

Excel formula: =LF.stripe.charges("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

created
default

date

-

currency
default

string

-

customer
default

id

customers

-

id
default

id

-

paid
default

boolean

-

status
default

enum

-

Edit

Update Charge

Update Charge

Route: PATCH /mutation/charges

Inputs you can set
NameTypeRequiredDescription
descriptionstringNo-
ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Checkout Sessions

Stripe Checkout sessions.

Read

Checkout Sessions

Stripe Checkout sessions.

Route: GET /checkoutSessions

Excel formula: =LF.stripe.checkoutSessions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
subscriptionidNoOnly sessions that created this subscription
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount_total
default

number

-

created
default

date

-

currency
default

string

-

customer
default

id

customers

-

id
default

id

-

payment_status
default

enum

-

status
default

enum

-

Create

Create Checkout Session

Create Checkout Session

Route: POST /mutation/checkoutSessions

Inputs you can set
NameTypeRequiredDescription
allow_promotion_codesbooleanNo-
automatic_tax.enabledbooleanNo-
billing_address_collectionenumNoValues: auto, required
cancel_urlstringNo-
client_reference_idstringNo-
customeridNo-
customer_emailstringNo-
expires_atnumberNo-
line_items.0.priceidNo-
line_items.0.quantitynumberNo-
modeenumYesValues: payment, subscription, setup
success_urlstringYes-
tax_id_collection.enabledbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Close Dispute

Concedes the dispute. Irreversible, and the money stays with the cardholder.

Create

Close Dispute

Close Dispute

Route: POST /mutation/disputeClose

Inputs you can set
NameTypeRequiredDescription
dispute_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Disputes

Disputes (chargebacks) raised by cardholders.

Read

Disputes

Disputes (chargebacks) raised by cardholders.

Route: GET /disputes

Excel formula: =LF.stripe.disputes("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
chargeidNoOnly disputes against this charge
statusenumNoFilter by dispute status Values: warning_needs_response, warning_under_review, warning_closed, needs_response, under_review
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

charge
default

id

-

created
default

date

-

currency
default

string

-

id
default

id

-

reason
default

string

-

status
default

enum

-

Edit

Update Dispute

Update Dispute

Route: PATCH /mutation/disputes

Inputs you can set
NameTypeRequiredDescription
evidence.cancellation_policyidNo-
evidence.customer_communicationidNo-
evidence.customer_email_addressstringNo-
evidence.customer_namestringNo-
evidence.product_descriptionstringNo-
evidence.receiptidNo-
evidence.refund_policyidNo-
evidence.service_datestringNo-
evidence.shipping_carrierstringNo-
evidence.shipping_documentationidNo-
evidence.shipping_tracking_numberstringNo-
evidence.uncategorized_textstringNo-
ididYes-
submitbooleanNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Payment Intents

Payment intents tracking the lifecycle of a payment.

Read

Payment Intents

Payment intents tracking the lifecycle of a payment.

Route: GET /paymentIntents

Excel formula: =LF.stripe.paymentIntents("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
customeridNoFilter by customer
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

created
default

date

-

currency
default

string

-

customer
default

id

customers

-

id
default

id

-

status
default

enum

-

Create

Create Payment Intent

Create Payment Intent

Route: POST /mutation/paymentIntents

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
automatic_payment_methods[allow_redirects]stringNo-
automatic_payment_methods[enabled]booleanNo-
confirmbooleanNo-
currencystringYes-
customeridNo-
descriptionstringNo-
payment_methodidNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Payment Intent

Update Payment Intent

Route: PATCH /mutation/paymentIntents

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
automatic_payment_methods[allow_redirects]stringNo-
automatic_payment_methods[enabled]booleanNo-
confirmbooleanNo-
currencystringYes-
customeridNo-
descriptionstringNo-
payment_methodidNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Payouts

Payouts to your bank account.

Read

Payouts

Payouts to your bank account.

Route: GET /payouts

Excel formula: =LF.stripe.payouts("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
statusenumNoFilter by status Values: pending, paid, failed, canceled, in_transit
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

arrival_date
default

date

-

created
default

date

-

currency
default

string

-

id
default

id

-

status
default

enum

-

Create

Create Payout

Create Payout

Route: POST /mutation/payouts

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
currencystringYes-
descriptionstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Payout

Update Payout

Route: PATCH /mutation/payouts

Inputs you can set
NameTypeRequiredDescription
amountnumberYes-
currencystringYes-
descriptionstringNo-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Refunds

Refunds issued against charges or payment intents.

Read

Refunds

Refunds issued against charges or payment intents.

Route: GET /refunds

Excel formula: =LF.stripe.refunds("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
chargeidNoOnly refunds against this charge
payment_intentidNoOnly refunds against this payment intent
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

charge
default

id

-

created
default

date

-

currency
default

string

-

id
default

id

-

status
default

enum

-

Create

Create Refund

Create Refund

Route: POST /mutation/refunds

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
chargeidNo-
payment_intentidNo-
reasonenumNoValues: duplicate, fraudulent, requested_by_customer
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Refund

Update Refund

Route: PATCH /mutation/refunds

Inputs you can set
NameTypeRequiredDescription
amountnumberNo-
chargeidNo-
payment_intentidNo-
reasonenumNoValues: duplicate, fraudulent, requested_by_customer
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reverse Payout

Pulls a completed payout back into the Stripe balance.

Create

Reverse Payout

Reverse Payout

Route: POST /mutation/payoutReverse

Inputs you can set
NameTypeRequiredDescription
payout_ididYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Submit Dispute Evidence

Sends the drafted evidence to the bank. Final — evidence can be submitted once.

Edit

Submit Dispute Evidence

Submit Dispute Evidence

Route: PATCH /mutation/disputeSubmit

Inputs you can set
NameTypeRequiredDescription
ididYes-
submitbooleanYes-
Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reports

Balance

What is available now and what is still pending, per currency.

Read

Balance

What is available now and what is still pending, per currency.

Route: GET /balance

Excel formula: =LF.stripe.balance("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
Data returned in Excel
Field
Type
Relations
Description
available
default

string

-

connect_reserved

string

-

livemode
default

boolean

-

pending
default

string

-

Balance Transactions

Funds movements through your Stripe balance.

Read

Balance Transactions

Funds movements through your Stripe balance.

Route: GET /balanceTransactions

Excel formula: =LF.stripe.balanceTransactions("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
ididNoRead exactly this record. Answers one row, or a not-found error.
createdAfterstringNoOnly records created at or after this moment — an ISO date, or epoch seconds.
createdBeforestringNoOnly records created at or before this moment — an ISO date, or epoch seconds.
typestringNoFilter by type (e.g. charge, refund, payout)
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

created
default

date

-

currency
default

string

-

fee
default

number

-

id
default

id

-

net
default

number

-

status
default

enum

-

type
default

string

-

Payout Reconciliation

The charges, refunds and fees that make up one payout.

Read

Payout Reconciliation

The charges, refunds and fees that make up one payout.

Route: GET /payoutReconciliation

Excel formula: =LF.stripe.payoutReconciliation("selection", "fields")

Inputs you can set
NameTypeRequiredDescription
linkstringYes-
payoutidYes-
limitnumberNoRows per page (max 100) Default: 100
Data returned in Excel
Field
Type
Relations
Description
amount
default

number

-

created
default

date

-

currency
default

string

-

fee
default

number

-

id
default

id

-

net
default

number

-

type
default

enum

-