Connexion Stripe pour LinkyFlow

LinkyFlow connecte Excel a Stripe pour consulter, modifier et publier les donnees e-commerce utiles depuis un tableur.

Ressources

Requetes de lecture

Actions ecriture

Champs documentes

267

Workflows a ramener dans Excel

Chaque ressource ci-dessous correspond a un workflow tableur concret. Les lectures ramenent des colonnes utiles dans Excel; les creations et modifications indiquent ce qui peut etre relu en lignes avant envoi.

Billing

Accept Quote

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

Creation

Accept Quote

Route: POST /mutation/quoteAccept

Entrees configurables

Name	Type	Required	Description
`quote_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Cancel Quote

Withdraws the quote. It can no longer be accepted.

Creation

Cancel Quote

Route: POST /mutation/quoteCancel

Entrees configurables

Name	Type	Required	Description
`quote_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Cancel Subscription Schedule

Cancels the schedule and the subscription it drives.

Creation

Cancel Subscription Schedule

Route: POST /mutation/subscriptionScheduleCancel

Entrees configurables

Name	Type	Required	Description
`invoice_now`	boolean	No	-
`prorate`	boolean	No	-
`schedule_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Coupons

Discount coupons.

Lecture

Coupons

Discount coupons.

Route: GET /coupons

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Coupon

Route: POST /mutation/coupons

Entrees configurables

Name	Type	Required	Description
`amount_off`	number	No	-
`currency`	string	No	-
`duration`	enum	Yes	Values: forever, once, repeating
`duration_in_months`	number	No	-
`name`	string	No	-
`percent_off`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Coupon

Route: PATCH /mutation/coupons

Entrees configurables

Name	Type	Required	Description
`amount_off`	number	No	-
`currency`	string	No	-
`duration`	enum	Yes	Values: forever, once, repeating
`duration_in_months`	number	No	-
`name`	string	No	-
`percent_off`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Coupon

Route: DELETE /mutation/coupons

Entrees configurables

Name	Type	Required	Description
`amount_off`	number	No	-
`currency`	string	No	-
`duration`	enum	Yes	Values: forever, once, repeating
`duration_in_months`	number	No	-
`name`	string	No	-
`percent_off`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Credit Note Preview

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

Lecture

Credit Note Preview

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

Route: GET /creditNotesPreview

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`invoice`	id	Yes	-
`amount`	number	No	Amount in the smallest currency unit (e.g. cents).
`reason`	enum	No	Values: duplicate, fraudulent, order_change, product_unsatisfactory
`refund_amount`	number	No	Amount in the smallest currency unit (e.g. cents).
`credit_amount`	number	No	Amount in the smallest currency unit (e.g. cents).
`out_of_band_amount`	number	No	Amount in the smallest currency unit (e.g. cents).
`lines`	string	No	-

Donnees retournees dans 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.

Lecture

Credit Notes

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

Route: GET /creditNotes

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`invoice`	id	No	Only credit notes against this invoice
`customer`	id	No	Filter by customer
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Credit Note

Route: POST /mutation/creditNotes

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`credit_amount`	number	No	-
`invoice`	id	Yes	-
`lines`	string	No	-
`memo`	string	No	-
`out_of_band_amount`	number	No	-
`reason`	enum	No	Values: duplicate, fraudulent, order_change, product_unsatisfactory
`refund_amount`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Customer Portal Session

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

Creation

Create Portal Session

Route: POST /mutation/billingPortalSessions

Entrees configurables

Name	Type	Required	Description
`configuration`	id	No	-
`customer`	id	Yes	-
`locale`	string	No	-
`on_behalf_of`	id	No	-
`return_url`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Customers

Customers in your Stripe account.

Utilise comme filtre par

Charges · customer

Checkout Sessions · customer

Credit Notes · customer

Invoice Items · customer

Invoices · customer

Upcoming Invoice · customer

Meter Event Summaries · customer

Payment Intents · customer

Quotes · customer

Subscription Schedules · customer

Subscriptions · customer

Lecture

Customers

Customers in your Stripe account.

Route: GET /customers

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`email`	string	No	Filter by exact email
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Customer

Route: POST /mutation/customers

Entrees configurables

Name	Type	Required	Description
`currency`	string	No	-
`description`	string	No	-
`email`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	No	-
`phone`	string	No	-
`preferred_locales`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Customer

Route: PATCH /mutation/customers

Entrees configurables

Name	Type	Required	Description
`currency`	string	No	-
`description`	string	No	-
`email`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	No	-
`phone`	string	No	-
`preferred_locales`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Customer

Route: DELETE /mutation/customers

Entrees configurables

Name	Type	Required	Description
`currency`	string	No	-
`description`	string	No	-
`email`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	No	-
`phone`	string	No	-
`preferred_locales`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Finalize Invoice

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

Creation

Finalize Invoice

Route: POST /mutation/invoiceFinalize

Entrees configurables

Name	Type	Required	Description
`auto_advance`	boolean	No	-
`invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Finalize Quote

Issues the quote so the customer can accept it.

Creation

Finalize Quote

Route: POST /mutation/quoteFinalize

Entrees configurables

Name	Type	Required	Description
`expires_at`	number	No	-
`quote_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Invoice Items

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

Lecture

Invoice Items

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

Route: GET /invoiceItems

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`created` default	date	—	-
`currency` default	string	—	-
`customer` default	id	→ customers	-
`description` default	string	—	-
`id` default	id	—	-

Creation

Create Invoice Item

Route: POST /mutation/invoiceItems

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`currency`	string	No	-
`customer`	id	No	-
`description`	string	No	-
`invoice`	id	No	-
`price`	id	No	-
`quantity`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Invoice Item

Route: PATCH /mutation/invoiceItems

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`currency`	string	No	-
`customer`	id	No	-
`description`	string	No	-
`invoice`	id	No	-
`price`	id	No	-
`quantity`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Invoice Item

Route: DELETE /mutation/invoiceItems

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`currency`	string	No	-
`customer`	id	No	-
`description`	string	No	-
`invoice`	id	No	-
`price`	id	No	-
`quantity`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Invoices

Invoices issued to customers.

Lecture

Invoices

Invoices issued to customers.

Route: GET /invoices

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`status`	enum	No	Filter by status Values: draft, open, paid, uncollectible, void
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Invoice

Route: POST /mutation/invoices

Entrees configurables

Name	Type	Required	Description
`auto_advance`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`currency`	string	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Invoice

Route: PATCH /mutation/invoices

Entrees configurables

Name	Type	Required	Description
`auto_advance`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`currency`	string	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Draft Invoice

Route: DELETE /mutation/invoices

Entrees configurables

Name	Type	Required	Description
`auto_advance`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`currency`	string	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Mark Invoice Uncollectible

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

Creation

Mark Invoice Uncollectible

Route: POST /mutation/invoiceMarkUncollectible

Entrees configurables

Name	Type	Required	Description
`invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Meter Event Adjustments

Cancels a usage event already reported, by its identifier.

Creation

Cancel Usage Event

Route: POST /mutation/meterEventAdjustments

Entrees configurables

Name	Type	Required	Description
`cancel.identifier`	string	Yes	-
`event_name`	string	Yes	-
`type`	enum	Yes	Values: cancel

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Meter Event Summaries

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

Lecture

Meter Event Summaries

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

Route: GET /meterEventSummaries

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`meter_id`	id	Yes	-
`customer`	id	Yes	-
`start_time`	number	Yes	Epoch seconds
`end_time`	number	Yes	Epoch seconds
`value_grouping_window`	enum	No	Values: day, hour
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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.

Creation

Record Usage

Route: POST /mutation/meterEvents

Entrees configurables

Name	Type	Required	Description
`event_name`	string	Yes	-
`identifier`	string	No	-
`payload.stripe_customer_id`	id	Yes	-
`payload.value`	string	Yes	-
`timestamp`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Meters

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

Lecture

Meters

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

Route: GET /meters

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`status`	enum	No	Values: active, inactive
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Meter

Route: POST /mutation/meters

Entrees configurables

Name	Type	Required	Description
`customer_mapping.event_payload_key`	string	No	-
`customer_mapping.type`	enum	No	Values: by_id
`default_aggregation.formula`	enum	No	Values: sum, count
`display_name`	string	Yes	-
`event_name`	string	Yes	-
`value_settings.event_payload_key`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Meter

Route: PATCH /mutation/meters

Entrees configurables

Name	Type	Required	Description
`customer_mapping.event_payload_key`	string	No	-
`customer_mapping.type`	enum	No	Values: by_id
`default_aggregation.formula`	enum	No	Values: sum, count
`display_name`	string	Yes	-
`event_name`	string	Yes	-
`value_settings.event_payload_key`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Pause Subscription

Stops collecting on a subscription without cancelling it.

Modification

Pause Subscription

Route: PATCH /mutation/subscriptionPause

Entrees configurables

Name	Type	Required	Description
`id`	id	Yes	-
`pause_collection.behavior`	enum	No	Values: keep_as_draft, mark_uncollectible, void
`pause_collection.resumes_at`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Pay Invoice

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

Creation

Pay Invoice

Route: POST /mutation/invoicePay

Entrees configurables

Name	Type	Required	Description
`forgive`	boolean	No	-
`invoice_id`	id	Yes	-
`paid_out_of_band`	boolean	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Promotion Codes

Customer-facing codes that apply a coupon.

Lecture

Promotion Codes

Customer-facing codes that apply a coupon.

Route: GET /promotionCodes

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`code`	string	No	Filter by code
`active`	boolean	No	Filter by active state
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`active` default	boolean	—	-
`code` default	string	—	-
`coupon` default	id	—	-
`created` default	date	—	-
`id` default	id	—	-
`times_redeemed` default	number	—	-

Creation

Create Promotion Code

Route: POST /mutation/promotionCodes

Entrees configurables

Name	Type	Required	Description
`code`	string	No	-
`coupon`	id	Yes	-
`customer`	id	No	-
`expires_at`	number	No	-
`max_redemptions`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Promotion Code

Route: PATCH /mutation/promotionCodes

Entrees configurables

Name	Type	Required	Description
`code`	string	No	-
`coupon`	id	Yes	-
`customer`	id	No	-
`expires_at`	number	No	-
`max_redemptions`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Quotes

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

Lecture

Quotes

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

Route: GET /quotes

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`status`	enum	No	Values: draft, open, accepted, canceled
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Quote

Route: POST /mutation/quotes

Entrees configurables

Name	Type	Required	Description
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`customer`	id	No	-
`description`	string	No	-
`expires_at`	number	No	-
`footer`	string	No	-
`header`	string	No	-
`line_items`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Quote

Route: PATCH /mutation/quotes

Entrees configurables

Name	Type	Required	Description
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`customer`	id	No	-
`description`	string	No	-
`expires_at`	number	No	-
`footer`	string	No	-
`header`	string	No	-
`line_items`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Release Subscription Schedule

Detaches the schedule. The subscription keeps running, unmanaged.

Creation

Release Subscription Schedule

Route: POST /mutation/subscriptionScheduleRelease

Entrees configurables

Name	Type	Required	Description
`schedule_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Resume Subscription

Restarts a paused subscription.

Creation

Resume Subscription

Route: POST /mutation/subscriptionResume

Entrees configurables

Name	Type	Required	Description
`billing_cycle_anchor`	enum	No	Values: now, unchanged
`proration_behavior`	enum	No	Values: create_prorations, none, always_invoice
`subscription_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Invoice

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

Creation

Send Invoice

Route: POST /mutation/invoiceSend

Entrees configurables

Name	Type	Required	Description
`invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Subscription Change Preview

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

Lecture

Subscription Change Preview

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

Route: GET /subscriptionsUpcoming

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`subscription`	id	Yes	-
`subscription_items`	string	No	-
`subscription_proration_behavior`	enum	No	Values: create_prorations, none, always_invoice

Donnees retournees dans 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.

Lecture

Subscription Schedules

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

Route: GET /subscriptionSchedules

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`scheduled`	boolean	No	Only schedules that have not started
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`created` default	date	—	-
`customer` default	id	→ customers	-
`id` default	id	—	-
`phases` default	string	—	-
`status` default	enum	—	-
`subscription` default	id	—	-

Creation

Create Subscription Schedule

Route: POST /mutation/subscriptionSchedules

Entrees configurables

Name	Type	Required	Description
`customer`	id	No	-
`end_behavior`	enum	No	Values: release, cancel
`from_subscription`	id	No	-
`phases`	string	No	-
`start_date`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Subscription Schedule

Route: PATCH /mutation/subscriptionSchedules

Entrees configurables

Name	Type	Required	Description
`customer`	id	No	-
`end_behavior`	enum	No	Values: release, cancel
`from_subscription`	id	No	-
`phases`	string	No	-
`start_date`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Subscriptions

Recurring subscriptions.

Lecture

Subscriptions

Recurring subscriptions.

Route: GET /subscriptions

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`status`	enum	No	Filter by status Values: active, past_due, unpaid, canceled, incomplete
`price`	id	No	Filter by price
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Subscription

Route: POST /mutation/subscriptions

Entrees configurables

Name	Type	Required	Description
`automatic_tax.enabled`	boolean	No	-
`cancel_at_period_end`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`coupon`	id	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`items.0.price`	id	Yes	-
`items.0.quantity`	number	No	-
`metadata.linkyflow_external_reference`	string	No	-
`promotion_code`	id	No	-
`trial_end`	number	No	-
`trial_period_days`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Subscription

Route: PATCH /mutation/subscriptions

Entrees configurables

Name	Type	Required	Description
`automatic_tax.enabled`	boolean	No	-
`cancel_at_period_end`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`coupon`	id	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`items.0.price`	id	Yes	-
`items.0.quantity`	number	No	-
`metadata.linkyflow_external_reference`	string	No	-
`promotion_code`	id	No	-
`trial_end`	number	No	-
`trial_period_days`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Cancel Subscription

Route: DELETE /mutation/subscriptions

Entrees configurables

Name	Type	Required	Description
`automatic_tax.enabled`	boolean	No	-
`cancel_at_period_end`	boolean	No	-
`collection_method`	enum	No	Values: charge_automatically, send_invoice
`coupon`	id	No	-
`customer`	id	Yes	-
`days_until_due`	number	No	-
`items.0.price`	id	Yes	-
`items.0.quantity`	number	No	-
`metadata.linkyflow_external_reference`	string	No	-
`promotion_code`	id	No	-
`trial_end`	number	No	-
`trial_period_days`	number	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Tax Calculation

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

Creation

Calculate Tax

Route: POST /mutation/taxCalculations

Entrees configurables

Name	Type	Required	Description
`currency`	string	Yes	-
`customer`	id	No	-
`customer_details.address.country`	string	No	-
`customer_details.address.postal_code`	string	No	-
`customer_details.address.state`	string	No	-
`customer_details.address_source`	enum	No	Values: billing, shipping
`line_items`	string	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Tax Rates

Tax rates applied to invoices and subscriptions.

Lecture

Tax Rates

Tax rates applied to invoices and subscriptions.

Route: GET /taxRates

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`active`	boolean	No	Filter by active state
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`active` default	boolean	—	-
`created` default	date	—	-
`display_name` default	string	—	-
`id` default	id	—	-
`inclusive` default	boolean	—	-
`percentage` default	number	—	-

Creation

Create Tax Rate

Route: POST /mutation/taxRates

Entrees configurables

Name	Type	Required	Description
`country`	string	No	-
`display_name`	string	Yes	-
`inclusive`	boolean	Yes	-
`jurisdiction`	string	No	-
`percentage`	number	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Tax Rate

Route: PATCH /mutation/taxRates

Entrees configurables

Name	Type	Required	Description
`country`	string	No	-
`display_name`	string	Yes	-
`inclusive`	boolean	Yes	-
`jurisdiction`	string	No	-
`percentage`	number	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Tax Transactions

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

Lecture

Tax Transactions

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

Route: GET /taxTransactions

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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.

Lecture

Upcoming Invoice

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

Route: GET /invoicesUpcoming

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`customer`	id	No	Filter by customer
`subscription`	id	No	Preview this subscription’s next invoice
`subscription_items`	string	No	Items to price as if they were already applied
`subscription_proration_behavior`	enum	No	Values: create_prorations, none, always_invoice
`subscription_proration_date`	number	No	Epoch seconds the proration is computed at

Donnees retournees dans 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.

Creation

Void Credit Note

Route: POST /mutation/creditNoteVoid

Entrees configurables

Name	Type	Required	Description
`credit_note_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Void Invoice

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

Creation

Void Invoice

Route: POST /mutation/invoiceVoid

Entrees configurables

Name	Type	Required	Description
`invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Catalog

Prices

Prices attached to products.

Lecture

Prices

Prices attached to products.

Route: GET /prices

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`product`	id	No	Filter by product
`active`	boolean	No	Filter by active state
`type`	enum	No	Filter by price type Values: one_time, recurring
`currency`	string	No	Filter by three-letter ISO currency code
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Price

Route: POST /mutation/prices

Entrees configurables

Name	Type	Required	Description
`currency`	string	Yes	-
`nickname`	string	No	-
`product`	id	Yes	-
`recurring.interval`	enum	No	Values: day, week, month, year
`recurring.interval_count`	number	No	-
`recurring.meter`	id	No	-
`recurring.usage_type`	enum	No	Values: licensed, metered
`tax_behavior`	enum	No	Values: inclusive, exclusive, unspecified
`type`	enum	No	Values: one_time, recurring
`unit_amount`	number	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Price

Route: PATCH /mutation/prices

Entrees configurables

Name	Type	Required	Description
`currency`	string	Yes	-
`nickname`	string	No	-
`product`	id	Yes	-
`recurring.interval`	enum	No	Values: day, week, month, year
`recurring.interval_count`	number	No	-
`recurring.meter`	id	No	-
`recurring.usage_type`	enum	No	Values: licensed, metered
`tax_behavior`	enum	No	Values: inclusive, exclusive, unspecified
`type`	enum	No	Values: one_time, recurring
`unit_amount`	number	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Products

Products in your Stripe catalog.

Utilise comme filtre par

Prices · product

Lecture

Products

Products in your Stripe catalog.

Route: GET /products

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`active`	boolean	No	Filter by active state
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`active` default	boolean	—	-
`created` default	date	—	-
`default_price` default	id	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-

Creation

Create Product

Route: POST /mutation/products

Entrees configurables

Name	Type	Required	Description
`active`	boolean	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	Yes	-
`statement_descriptor`	string	No	-
`tax_code`	string	No	-
`unit_label`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Product

Route: PATCH /mutation/products

Entrees configurables

Name	Type	Required	Description
`active`	boolean	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	Yes	-
`statement_descriptor`	string	No	-
`tax_code`	string	No	-
`unit_label`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Product

Route: DELETE /mutation/products

Entrees configurables

Name	Type	Required	Description
`active`	boolean	No	-
`description`	string	No	-
`metadata.linkyflow_external_reference`	string	No	-
`name`	string	Yes	-
`statement_descriptor`	string	No	-
`tax_code`	string	No	-
`unit_label`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Shipping Rates

Delivery options and their cost, offered at checkout.

Lecture

Shipping Rates

Delivery options and their cost, offered at checkout.

Route: GET /shippingRates

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`active`	boolean	No	-
`currency`	string	No	-
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Shipping Rate

Route: POST /mutation/shippingRates

Entrees configurables

Name	Type	Required	Description
`delivery_estimate.maximum.unit`	enum	No	Values: hour, day, business_day, week, month
`delivery_estimate.maximum.value`	number	No	-
`delivery_estimate.minimum.unit`	enum	No	Values: hour, day, business_day, week, month
`delivery_estimate.minimum.value`	number	No	-
`display_name`	string	Yes	-
`fixed_amount.amount`	number	Yes	-
`fixed_amount.currency`	string	Yes	-
`tax_behavior`	enum	No	Values: inclusive, exclusive, unspecified

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Shipping Rate

Route: PATCH /mutation/shippingRates

Entrees configurables

Name	Type	Required	Description
`delivery_estimate.maximum.unit`	enum	No	Values: hour, day, business_day, week, month
`delivery_estimate.maximum.value`	number	No	-
`delivery_estimate.minimum.unit`	enum	No	Values: hour, day, business_day, week, month
`delivery_estimate.minimum.value`	number	No	-
`display_name`	string	Yes	-
`fixed_amount.amount`	number	Yes	-
`fixed_amount.currency`	string	Yes	-
`tax_behavior`	enum	No	Values: inclusive, exclusive, unspecified

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Connect

Account Links

A short-lived onboarding link for a connected account.

Creation

Create Onboarding Link

Route: POST /mutation/accountLinks

Entrees configurables

Name	Type	Required	Description
`account`	id	Yes	-
`refresh_url`	string	Yes	-
`return_url`	string	Yes	-
`type`	enum	Yes	Values: account_onboarding, account_update

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Application Fees

Fees the platform collected on connected-account charges.

Lecture

Application Fees

Fees the platform collected on connected-account charges.

Route: GET /applicationFees

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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.

Lecture

Connected Account Requirements

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

Route: GET /accountRequirements

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	Yes	-

Donnees retournees dans 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.

Lecture

Connected Accounts

Accounts connected to this platform.

Route: GET /accounts

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Connected Account

Route: POST /mutation/accounts

Entrees configurables

Name	Type	Required	Description
`country`	string	No	-
`email`	string	No	-
`type`	enum	No	Values: standard, express, custom

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Connected Account

Route: PATCH /mutation/accounts

Entrees configurables

Name	Type	Required	Description
`country`	string	No	-
`email`	string	No	-
`type`	enum	No	Values: standard, express, custom

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Transfer Reversals

Pulls a transfer back from a connected account.

Creation

Reverse Transfer

Route: POST /mutation/transferReversals

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`refund_application_fee`	boolean	No	-
`transfer_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Transfers

Money moved from the platform balance to a connected account.

Lecture

Transfers

Money moved from the platform balance to a connected account.

Route: GET /transfers

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`destination`	id	No	Only transfers to this connected account
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Transfer

Route: POST /mutation/transfers

Entrees configurables

Name	Type	Required	Description
`amount`	number	Yes	-
`currency`	string	Yes	-
`description`	string	No	-
`destination`	id	Yes	-
`transfer_group`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Developers

Events

Account activity events.

Lecture

Events

Account activity events.

Route: GET /events

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`type`	string	No	Filter by event type (e.g. invoice.paid)
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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.

Creation

Cancel Payout

Route: POST /mutation/payoutCancel

Entrees configurables

Name	Type	Required	Description
`payout_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Cancel Refund

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

Creation

Cancel Refund

Route: POST /mutation/refundCancel

Entrees configurables

Name	Type	Required	Description
`refund_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Charges

Individual charges.

Lecture

Charges

Individual charges.

Route: GET /charges

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Modification

Update Charge

Route: PATCH /mutation/charges

Entrees configurables

Name	Type	Required	Description
`description`	string	No	-
`id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Checkout Sessions

Stripe Checkout sessions.

Lecture

Checkout Sessions

Stripe Checkout sessions.

Route: GET /checkoutSessions

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`subscription`	id	No	Only sessions that created this subscription
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Creation

Create Checkout Session

Route: POST /mutation/checkoutSessions

Entrees configurables

Name	Type	Required	Description
`allow_promotion_codes`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`billing_address_collection`	enum	No	Values: auto, required
`cancel_url`	string	No	-
`client_reference_id`	string	No	-
`customer`	id	No	-
`customer_email`	string	No	-
`expires_at`	number	No	-
`line_items.0.price`	id	No	-
`line_items.0.quantity`	number	No	-
`mode`	enum	Yes	Values: payment, subscription, setup
`success_url`	string	Yes	-
`tax_id_collection.enabled`	boolean	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Close Dispute

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

Creation

Close Dispute

Route: POST /mutation/disputeClose

Entrees configurables

Name	Type	Required	Description
`dispute_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Disputes

Disputes (chargebacks) raised by cardholders.

Lecture

Disputes

Disputes (chargebacks) raised by cardholders.

Route: GET /disputes

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`charge`	id	No	Only disputes against this charge
`status`	enum	No	Filter by dispute status Values: warning_needs_response, warning_under_review, warning_closed, needs_response, under_review
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-

Modification

Update Dispute

Route: PATCH /mutation/disputes

Entrees configurables

Name	Type	Required	Description
`evidence.cancellation_policy`	id	No	-
`evidence.customer_communication`	id	No	-
`evidence.customer_email_address`	string	No	-
`evidence.customer_name`	string	No	-
`evidence.product_description`	string	No	-
`evidence.receipt`	id	No	-
`evidence.refund_policy`	id	No	-
`evidence.service_date`	string	No	-
`evidence.shipping_carrier`	string	No	-
`evidence.shipping_documentation`	id	No	-
`evidence.shipping_tracking_number`	string	No	-
`evidence.uncategorized_text`	string	No	-
`id`	id	Yes	-
`submit`	boolean	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Payment Intents

Payment intents tracking the lifecycle of a payment.

Lecture

Payment Intents

Payment intents tracking the lifecycle of a payment.

Route: GET /paymentIntents

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`customer`	id	No	Filter by customer
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`created` default	date	—	-
`currency` default	string	—	-
`customer` default	id	→ customers	-
`id` default	id	—	-
`status` default	enum	—	-

Creation

Create Payment Intent

Route: POST /mutation/paymentIntents

Entrees configurables

Name	Type	Required	Description
`amount`	number	Yes	-
`automatic_payment_methods[allow_redirects]`	string	No	-
`automatic_payment_methods[enabled]`	boolean	No	-
`confirm`	boolean	No	-
`currency`	string	Yes	-
`customer`	id	No	-
`description`	string	No	-
`payment_method`	id	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Payment Intent

Route: PATCH /mutation/paymentIntents

Entrees configurables

Name	Type	Required	Description
`amount`	number	Yes	-
`automatic_payment_methods[allow_redirects]`	string	No	-
`automatic_payment_methods[enabled]`	boolean	No	-
`confirm`	boolean	No	-
`currency`	string	Yes	-
`customer`	id	No	-
`description`	string	No	-
`payment_method`	id	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Payment Links

Reusable shareable payment links. Unlike a checkout session, a link does not expire and can be paid many times.

Lecture

Payment Links

Reusable shareable payment links. Unlike a checkout session, a link does not expire and can be paid many times.

Route: GET /paymentLinks

Formule Excel: =LF.stripe.paymentLinks("selection", "fields")

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`active`	boolean	No	Filter by whether the link still works
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`active` default	boolean	—	-
`allow_promotion_codes`	boolean	—	-
`currency` default	string	—	-
`id` default	id	—	-
`url` default	string	—	-

Creation

Create Payment Link

Route: POST /mutation/paymentLinks

Entrees configurables

Name	Type	Required	Description
`after_completion.redirect.url`	string	No	-
`after_completion.type`	enum	No	Values: hosted_confirmation, redirect
`allow_promotion_codes`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`billing_address_collection`	enum	No	Values: auto, required
`line_items.0.price`	id	No	-
`line_items.0.quantity`	number	No	-
`metadata.linkyflow_external_reference`	string	No	-
`tax_id_collection.enabled`	boolean	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Payment Link

Route: PATCH /mutation/paymentLinks

Entrees configurables

Name	Type	Required	Description
`after_completion.redirect.url`	string	No	-
`after_completion.type`	enum	No	Values: hosted_confirmation, redirect
`allow_promotion_codes`	boolean	No	-
`automatic_tax.enabled`	boolean	No	-
`billing_address_collection`	enum	No	Values: auto, required
`line_items.0.price`	id	No	-
`line_items.0.quantity`	number	No	-
`metadata.linkyflow_external_reference`	string	No	-
`tax_id_collection.enabled`	boolean	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Payouts

Payouts to your bank account.

Lecture

Payouts

Payouts to your bank account.

Route: GET /payouts

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`status`	enum	No	Filter by status Values: pending, paid, failed, canceled, in_transit
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`arrival_date` default	date	—	-
`created` default	date	—	-
`currency` default	string	—	-
`id` default	id	—	-
`status` default	enum	—	-

Creation

Create Payout

Route: POST /mutation/payouts

Entrees configurables

Name	Type	Required	Description
`amount`	number	Yes	-
`currency`	string	Yes	-
`description`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Payout

Route: PATCH /mutation/payouts

Entrees configurables

Name	Type	Required	Description
`amount`	number	Yes	-
`currency`	string	Yes	-
`description`	string	No	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Refunds

Refunds issued against charges or payment intents.

Lecture

Refunds

Refunds issued against charges or payment intents.

Route: GET /refunds

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`charge`	id	No	Only refunds against this charge
`payment_intent`	id	No	Only refunds against this payment intent
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`charge` default	id	—	-
`created` default	date	—	-
`currency` default	string	—	-
`id` default	id	—	-
`status` default	enum	—	-

Creation

Create Refund

Route: POST /mutation/refunds

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`charge`	id	No	-
`payment_intent`	id	No	-
`reason`	enum	No	Values: duplicate, fraudulent, requested_by_customer

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Refund

Route: PATCH /mutation/refunds

Entrees configurables

Name	Type	Required	Description
`amount`	number	No	-
`charge`	id	No	-
`payment_intent`	id	No	-
`reason`	enum	No	Values: duplicate, fraudulent, requested_by_customer

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Reverse Payout

Pulls a completed payout back into the Stripe balance.

Creation

Reverse Payout

Route: POST /mutation/payoutReverse

Entrees configurables

Name	Type	Required	Description
`payout_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Submit Dispute Evidence

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

Modification

Submit Dispute Evidence

Route: PATCH /mutation/disputeSubmit

Entrees configurables

Name	Type	Required	Description
`id`	id	Yes	-
`submit`	boolean	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Reports

Balance

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

Lecture

Balance

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

Route: GET /balance

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-

Donnees retournees dans 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.

Lecture

Balance Transactions

Funds movements through your Stripe balance.

Route: GET /balanceTransactions

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`createdAfter`	string	No	Only records created at or after this moment — an ISO date, or epoch seconds.
`createdBefore`	string	No	Only records created at or before this moment — an ISO date, or epoch seconds.
`type`	string	No	Filter by type (e.g. charge, refund, payout)
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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.

Lecture

Payout Reconciliation

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

Route: GET /payoutReconciliation

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`payout`	id	Yes	-
`limit`	number	No	Rows per page (max 100) Default: 100

Donnees retournees dans 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	—	-