Stripe

DESTRUCTIVE. Accepts the specified quote. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Reactivates this alert, allowing it to trigger again.

Adds multiple line items to an invoice. This is only possible when an invoice is still a draft. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE and TIME-CRITICAL: approve a card authorization that is waiting on the platform's real-time decision, with a merchant terminal live at the other end. THIS SPENDS REAL MONEY -- approving commits the funding balance, and the only recovery is a dispute. Stripe gives roughly two seconds before it applies the account's default, so an unanswered authorization is not a safe state. `amount` may approve a LOWER amount than requested, which is the bounded way to say yes. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Approves a Review object, closing it and removing it from the list of reviews. Overrides Stripe Radar's fraud hold on one specific live payment and lets it capture. Nothing in the request tells you whether the payment is fraudulent, and there is no un-approve: if it was fraud, the merchant now owns a chargeback plus the dispute fee. The reverse decision is not this tool's opposite -- Stripe has no decline-review endpoint; leaving a review alone lets it expire and the payment cancel. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Archives this alert, removing it from the list view and APIs. This is non-reversible.

DESTRUCTIVE. Updates the status of an invoice rendering template to 'archived' so no new Stripe objects (customers, invoices, etc.) can reference it. The template can also no longer be updated. However, if the template is already set on a Stripe object, it will continue to be applied on invoices generated by it.

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments. For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited to the invoice, increasing its amount_paid. When the invoice is fully paid, the invoice's status becomes paid. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Attaches a PaymentMethod object to a Customer. To attach a new PaymentMethod to a customer for future payments, we recommend you use a SetupIntent or a PaymentIntent with setup_future_usage. These approaches will perform any necessary steps to set up the PaymentMethod for future payments. The inverse of stripe_detach_payment_method. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: cancel a carbon-removal order. Stripe refunds the uncertified portion to the account balance and KEEPS the rest -- anything the supplier has already delivered is not refundable, so the money back is usually less than the money spent, and there is no un-cancel. This is the inverse of stripe_create_climate_order and it is deliberately not a clean one. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Cancels a customer's subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: cancel an identity verification session that has not been completed, invalidating its link so the person cannot finish it. There is no un-cancel: a new session has to be created and the person asked to submit their documents again. Their already-collected data is NOT deleted by this -- stripe_redact_identity_verification_session is the action that does that.

Cancel a PaymentIntent that has not completed, which RELEASES an uncaptured card hold back to the cardholder. This is a SAFETY operation: a hold left in place keeps the customer's funds unavailable for up to seven days, and until now Agentic Fabriq offered no way to release one. Works while the intent is requires_payment_method, requires_capture, requires_confirmation, requires_action or (rarely) processing; anything already succeeded must be refunded with stripe_create_refund instead. DESTRUCTIVE and one-way: a cancelled PaymentIntent cannot be revived, the customer has to start a new payment, and any amount_capturable is automatically refunded. Needs confirm_live_mode=true on a live connection.

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Cancels the quote. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Cancels a refund with a status of requires_action. You can't cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state. The inverse of stripe_create_refund, and the ONLY one Stripe offers: it works exclusively while the refund is still in `pending` status (bank-transfer style methods). A `succeeded` refund cannot be cancelled or reversed by anyone -- the money is gone. Check stripe_get_refund first. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: abandon a SetupIntent that has not succeeded. No money is involved either way, but the object is finished afterwards -- it cannot be revived, and the customer has to be sent through a new setup flow. Use it to clear an abandoned 'add a card' attempt rather than leaving it pending.

DESTRUCTIVE — stops a real billing relationship when this connection uses a live key. By DEFAULT (immediately=false) it sets cancel_at_period_end, which is REVERSIBLE: the customer keeps access until the period they have already paid for ends, no proration is calculated, and a human can undo it in the Stripe dashboard before then. That is what a support request almost always means. With immediately=true it cancels NOW, which is TERMINAL — Stripe has no un-cancel, and restoring service means creating a new subscription with a new billing anchor and no history. Prefer the default unless the user explicitly asked to stop billing today. On a live-mode connection this call is REFUSED unless you pass confirm_live_mode=true.

DESTRUCTIVE. Cancels a subscription schedule and its associated subscription immediately (if the subscription schedule has an active subscription). A subscription schedule can only be canceled if its status is not_started or active. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Clear whatever the reader is currently showing or waiting for and return it to idle. This is the SAFETY action of the Terminal family: it is how a payment prompt left on a screen in front of a customer gets taken down. It never takes money and it is the inverse of the process/collect actions.

Cancels a top-up. Only pending top-ups can be canceled. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Stop an inbound transfer before it is submitted to the bank -- the inverse of stripe_create_treasury_inbound_transfer and a safety action, not a destructive one. Once the transfer has been submitted Stripe refuses, and the money can only come back as a return. Needs confirm_live_mode=true on a live connection.

Stop an outbound payment before it is submitted to the network -- the inverse of stripe_create_treasury_outbound_payment and the only undo that exists. Stripe refuses once the payment has been posted. Needs confirm_live_mode=true on a live connection.

Stop an outbound transfer before it is submitted to the network -- the inverse of stripe_create_treasury_outbound_transfer. Stripe refuses once it has been posted. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute (accepting it), acknowledging it as lost. The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible. IRREVERSIBLE, in Stripe's own words: "Closing a dispute is irreversible." It forfeits the disputed amount to the cardholder and counts against the account's dispute rate. There is no reopen. Use it only when a human has decided not to contest. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE and permanent: close a Treasury financial account. Stripe requires a zero balance first and there is NO reopen -- a new account means new account and routing numbers, so every payer sending to the old ones has to be told. Read the balance with stripe_get_treasury_financial_account before calling this. Needs confirm_live_mode=true on a live connection.

Ask the person at the reader a question on its screen -- signature, selection, phone number, email, a numeric or text entry -- and return what they enter. No money moves. Everything collected is customer input that will land in the agent's context, so ask for the minimum the task needs. stripe_cancel_terminal_reader_action aborts the prompt.

Prompt the reader to collect the customer's card details for an existing PaymentIntent WITHOUT charging it -- the two- step form of in-person payment, where stripe_confirm_terminal_reader_payment_intent is the step that takes the money. Nothing is charged by this call, but it puts a live prompt in front of a real person, so it is live-mode gated and needs confirm_live_mode=true on a live connection. stripe_cancel_terminal_reader_action takes the prompt down.

Confirm a SetupIntent with a payment method that already exists, which is what actually saves the instrument against the customer for future billing. It takes no money now; it authorises future charges, which is why it is live-mode gated. Refuses inline payment_method_data (raw card details, E8), return_url (a caller-chosen URL, E2) and client_secret. If the bank asks for authentication the intent lands in requires_action and a human has to finish it -- an agent cannot. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: confirm a PaymentIntent whose card details the reader has already collected, which is the step that actually charges the cardholder. Bounded by the PaymentIntent's own amount, which this call does not set. The undo is a refund and it does not return the processing fee. Needs confirm_live_mode=true on a live connection.

Creates a new account or customer tax_id object.

DESTRUCTIVE. Refunds an application fee that has previously been collected but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected. You can optionally refund only part of an application fee. You can do so multiple times, until the entire fee has been refunded. Once entirely refunded, an application fee can't be refunded again. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Creates a billing alert

DESTRUCTIVE. Creates a credit grant. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Creates a billing meter.

Creates a billing meter event.

Creates a billing meter event adjustment.

Create a customer-portal configuration: which self-service actions customers may take -- update payment method, cancel a subscription, switch plans, view invoices. NOTE what this really decides: it is the rule set customers act under, so enabling subscription_cancel lets every customer cancel without touching Stripe again. `features` is required. It creates no session and exposes no link -- portal sessions are refused (E1, they mint a credential-bearing URL).

DESTRUCTIVE. When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Buy carbon removal from a Stripe Climate supplier, priced either by `amount` (a hard cash ceiling in the smallest currency unit) or by `metric_tons`. THIS SPENDS REAL MONEY off the account balance. It ships rather than being refused because Stripe offers the cap parameter that E4 asks for -- pass `amount` and the spend is bounded by construction. Its inverse is stripe_cancel_climate_order, which works only until the supplier confirms delivery. Needs confirm_live_mode=true on a live connection.

Create a connected account under this platform -- the first step of onboarding a merchant, seller or service provider. Creating one charges nothing and takes no money; it cannot accept payments until its capabilities are requested and its verification requirements are met, which stripe_get_connected_account reports. Its inverse is stripe_delete_connected_account, which only works while the account has no balance. The payout destination cannot be set here: external_account and bank_account are refused, because they redirect every future payout and carry raw bank details. Government identification numbers are refused wherever they appear, including nested under individual or company.

Add a person -- director, owner, executive or representative -- to a connected account so Stripe can verify it. `relationship` is what makes the person count towards a requirement; a person with no relationship flags satisfies nothing. Government identification numbers are REFUSED as arguments (id_number, ssn_last_4 and the person_token that carries them): putting a national identity number in an agent's prompt is the same compliance move as putting a card number there, so that step stays with the human onboarding flow. Everything else -- name, date of birth, address, email, relationship -- is here. Stripe publishes /people and /persons as the SAME endpoint under two names; this is the /people spelling and stripe_create_connected_account_person is the /persons one. Either works.

Add a person -- director, owner, executive or representative -- to a connected account so Stripe can verify it. `relationship` is what makes the person count towards a requirement; a person with no relationship flags satisfies nothing. Government identification numbers are REFUSED as arguments (id_number, ssn_last_4 and the person_token that carries them): putting a national identity number in an agent's prompt is the same compliance move as putting a card number there, so that step stays with the human onboarding flow. Everything else -- name, date of birth, address, email, relationship -- is here.

You can create coupons easily via the coupon management page of the Stripe dashboard. Coupon creation is also accessible via the API if you need to create coupons on the fly. A coupon has either a percent_off or an amount_off and currency. If you set an amount_off, that amount will be subtracted from any invoice's subtotal.

DESTRUCTIVE. Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice's amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note's pre_payment_amount. The correct instrument for "cancel this invoice's charge" on an invoiced customer, and bounded like a refund: Stripe caps it at the invoice total. Note that `refund_amount` on the same call ALSO moves real money out of the balance, exactly like stripe_create_refund and with the same irreversibility. The inverse is stripe_void_credit_note. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Create a Stripe customer with contact details only: email, name, phone, address, description and metadata. No payment method, no balance and no default source -- attaching a card is stripe_attach_payment_method, and the balance field is refused for the same reason it is refused on stripe_update_customer. The inverse is stripe_delete_customer, which is permanent.

DESTRUCTIVE. Creates a new subscription on an existing customer. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Creates a new tax_id object for a customer.

Creates an entitlement feature -- a named capability of your product that subscriptions can grant, such as "api_access" or "priority_support". Creating one changes nothing for existing customers on its own; a feature only takes effect once it is attached to a product. Stripe does not let a feature's lookup_key be changed afterwards, so the key chosen here is permanent.

This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Issue a virtual or physical card to a cardholder. THIS CREATES A SPENDING INSTRUMENT: every authorization it approves is real money off the funding balance. `spending_controls` is REQUIRED here even though Stripe makes it optional -- E4 says an operation with a cap parameter ships WITH the cap, so a card without a spending limit is not something Agentic Fabriq will create. Set spending_controls[spending_limits][0][amount] and [interval]. The PIN is refused (E8). Its inverse is stripe_update_issuing_card with status=canceled, which is terminal. Needs confirm_live_mode=true on a live connection.

Create the person or company a card will be issued to. This spends nothing on its own -- a cardholder with no card cannot transact -- but it is the prerequisite for stripe_create_issuing_card. `billing` and `name` are required. Government identification numbers are refused as arguments (E8); the individual's verification documents go through Stripe's own flow.

Dispute a transaction on a card this account ISSUED -- the chargeback the platform files on its cardholder's behalf, bounded by the transaction's own amount. Creating it does not submit it: it stays in unsubmitted until stripe_submit_issuing_dispute sends it to the card network, so evidence can be assembled first. Needs confirm_live_mode=true on a live connection because it claims real money back.

Create a physical-card design -- logo, carrier text and the physical bundle it prints on. No money moves; Stripe reviews the design before it can be used. Get a physical_bundle id from stripe_list_issuing_physical_bundles and a card logo file id from stripe_list_files.

Create a named set of payment methods to offer at checkout -- card, Link, Klarna, iDEAL, SEPA and the rest -- each turned on or off through its display_preference. It charges nothing; it decides what customers are offered. Every payment method Stripe publishes is declared here rather than a chosen subset, because a payment method left out of the schema is one an agent silently cannot enable.

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Creates a new Price for an existing Product. The Price can be recurring or one-time.

Creates a new product object.

Creates a product_feature, which represents a feature attachment to a product

A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

A quote models prices and services for a customer. Default options for header, description, footer, and expires_at can be set in the dashboard via the quote template. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE — MOVES REAL MONEY when this connection uses a live key. Returns funds from the Stripe balance to the customer's original payment method. There is NO un-refund: once issued it cannot be reversed from Stripe or from Agentic Fabriq, and the card processing fee on the original charge is generally not returned. Stripe caps the amount at the charge's remaining unrefunded balance, so it can never overshoot — but it can be issued TWICE if you do not check first, so call stripe_list_refunds before this one. Provide exactly one of `charge` or `payment_intent`. `amount` is in the currency's smallest unit (1250 = $12.50 for USD); omit it to refund the full remaining amount. On a live-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check `stripe_mode` from any read tool first. Supply a stable `idempotency_key` derived from the thing being refunded if there is any chance of retrying.

Run one of Stripe's own reports -- balance change from activity, payout reconciliation, itemised payments, customer lists -- over a date range, and return a file id to download with stripe_get_file. THIS IS A BULK EXPORT: a report run can materialise every balance transaction, payout or customer row in the range into a single file, which is a far larger disclosure than any list action here. It stays bounded because the file goes to STRIPE'S OWN storage, never to a destination this call names, and because the date range in `parameters` is the ceiling -- set interval_start and interval_end deliberately rather than omitting them. Get valid report_type values from stripe_list_reporting_report_types.

Start collecting a card or bank account to store on file for later billing, without charging anything now. A SetupIntent takes NO money: it is the object behind 'add a payment method to this subscription'. Agentic Fabriq refuses the inline payment_method_data (raw card details, E8) and return_url (a caller-chosen URL, E2), so this creates the intent and the customer completes it in a Stripe-hosted flow, or the agent attaches a payment method that already exists. The client_secret Stripe returns is scrubbed from the result.

Creates a new shipping rate object.

DESTRUCTIVE. Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with collection_method=charge_automatically, the first invoice is finalized as part of the request. The payment_behavior parameter determines the exact behavior of the initial payment. Starts real recurring billing on a real customer's saved payment method. It is bounded by a real prior object -- the amount comes from a price_... id a human created, not from a number the agent chose -- which is why it ships where stripe charge creation does not, but the loss is recurring rather than one-off. The inverse is stripe_cancel_subscription. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Adds a new item to an existing subscription. No existing items will be changed or replaced. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Creates a new subscription schedule object. Each customer can have up to 500 active or scheduled subscriptions. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Calculates tax based on the input and returns a Tax Calculation object.

Creates a new tax rate.

Creates a new Tax Registration object.

Creates a Tax Transaction from a calculation, if that calculation hasn't expired. Calculations expire after 90 days. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Create a reader configuration profile: tipping options, reboot window and the per-model display settings. It changes how readers behave, not what they charge. Its inverse is stripe_delete_terminal_configuration.

Create the physical address a set of readers belongs to. No money moves. Its inverse is stripe_delete_terminal_location.

Register a physical card reader against a location using the registration code shown on the device. No money moves and the device takes no payments until one is driven to it. Its inverse is stripe_delete_terminal_reader. Get a location id from stripe_list_terminal_locations.

DESTRUCTIVE. Internal endpoint for terminal use to create a refund for a card_present or card charge. You can optionally refund only part of a charge. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: send a ReceivedCredit back to where it came from. THIS MOVES REAL MONEY OUT of the financial account, bounded by the original credit's amount, and there is no un- reverse -- the sender has to send it again. This is the correct handling for money that arrived in error. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: reverse a ReceivedDebit, pulling the money back into the financial account. Bounded by the original debit and only possible while Stripe still allows it (reversible=true on the debit). It cannot be undone once submitted. Needs confirm_live_mode=true on a live connection.

Open a Treasury stored-value account for a connected account. Creating one moves no money; it is the container the money later sits in. `supported_currencies` is required. Its inverse is stripe_close_treasury_financial_account, which Stripe only allows at a zero balance.

DESTRUCTIVE: debit a verified external bank account and move the money INTO a Treasury financial account. THIS MOVES REAL MONEY out of somebody's bank account -- bounded by the required `amount`, and only to an origin_payment_method that already exists on the account. It can be returned by the bank days later, which reverses the balance. stripe_cancel_treasury_inbound_transfer works only while it is still processing. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: send money from a Treasury financial account to a third party by ACH or wire. THIS MOVES REAL MONEY OUT and a settled outbound payment cannot be recalled by anyone at Stripe. It ships rather than being refused because `amount` is a required cap, but the RECIPIENT is the risk here, so Agentic Fabriq refuses destination_payment_method_data -- the field that would let a call name a brand-new bank account inline. Only a destination the account already holds can be paid. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: move money from a Treasury financial account out to the connected account's OWN linked bank account. THIS MOVES REAL MONEY OUT, bounded by the required `amount`, and a settled transfer cannot be recalled. destination_payment_method_data is refused, so it can only go to a destination the account already holds. stripe_cancel_treasury_outbound_transfer works until it is submitted. Needs confirm_live_mode=true on a live connection.

Deactivates this alert, preventing it from triggering.

DESTRUCTIVE. When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.

DESTRUCTIVE: decline a pending card authorization. No money moves, but a real person's card is refused at a real terminal and there is no undo -- the merchant has to run the transaction again. It is the inverse of stripe_approve_issuing_authorization and the safer default when the answer is unclear.

Deletes an existing account or customer tax_id object.

Delete an apple pay domain.

DESTRUCTIVE and permanent: delete a connected account. Stripe refuses while the account holds a balance or has pending payouts, which is the only guard there is -- once it succeeds the account, its people and its payment history are gone from the platform's view and no Agentic Fabriq action brings them back. Prefer stripe_reject_connected_account, which stops the account and IS reversible with stripe_unreject_connected_account. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: remove a bank account from a connected account's payout destinations. If it was the default for its currency, payouts in that currency STOP until another one is set -- and Agentic Fabriq cannot put it back, because adding an external account carries raw bank and routing numbers and is refused (E8). The undo is a human in the Stripe dashboard. Read stripe_list_connected_account_external_accounts first to see whether this is the default. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: remove a payout destination (bank account or debit card) from a connected account. Same warning as stripe_delete_connected_account_bank_account and the same missing undo: deleting the default destination stops payouts in that currency, and re-adding one is refused by Agentic Fabriq because it carries raw bank or card details. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: remove a person from a connected account. Stripe refuses to delete a person who is the account_opener, and removing anyone else can re-open a verification requirement the account had already satisfied, which stops payouts. Re-adding is possible with the create action but the identity documents and verification status do NOT come back -- those have to be supplied again through the human onboarding flow, so treat this as one-way. The /people spelling of the same Stripe endpoint as stripe_delete_connected_account_person.

DESTRUCTIVE: remove a person from a connected account. Stripe refuses to delete a person who is the account_opener, and removing anyone else can re-open a verification requirement the account had already satisfied, which stops payouts. Re-adding is possible with the create action but the identity documents and verification status do NOT come back -- those have to be supplied again through the human onboarding flow, so treat this as one-way.

DESTRUCTIVE. You can delete coupons via the coupon management page of the Stripe dashboard. However, deleting a coupon does not affect any customers who have already applied the coupon; it means that new customers can't redeem the coupon. You can also delete coupons via the API.

DESTRUCTIVE. Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer. Permanent, and it cascades: the customer's payment methods are detached and every subscription they hold is cancelled. Stripe has no undelete. stripe_create_customer can make a NEW customer with the same details, but the id, the payment methods, the invoice history and the subscriptions do not come back.

DESTRUCTIVE: detach a saved bank account from a customer. If it was the default source, every subscription and invoice that billed to it starts failing at the next cycle, and Agentic Fabriq CANNOT re-add it: attaching a card or bank account requires the raw details, which is refused (E8). The customer has to re-enter them through a checkout or portal flow. Read stripe_get_customer to see the default source before removing anything. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: detach a saved card from a customer. If it was the default source, every subscription and invoice that billed to it starts failing at the next cycle, and Agentic Fabriq CANNOT re-add it: attaching a card or bank account requires the raw details, which is refused (E8). The customer has to re-enter them through a checkout or portal flow. Read stripe_get_customer to see the default source before removing anything. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Removes the currently applied discount on a customer. Removes an active coupon from a customer, so the next invoice is at full price. The inverse is stripe_update_customer_subscription (or a new promotion code) applying the coupon again -- the coupon object itself is not deleted. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: detach a saved source from a customer. If it was the default source, every subscription and invoice that billed to it starts failing at the next cycle, and Agentic Fabriq CANNOT re-add it: attaching a card or bank account requires the raw details, which is refused (E8). The customer has to re-enter them through a checkout or portal flow. Read stripe_get_customer to see the default source before removing anything. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Removes the currently applied discount on a customer. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Deletes an existing tax_id object.

DESTRUCTIVE. Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they're not attached to invoices, or if it's attached to a draft invoice. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Deleting plans means new subscribers can't be added. Existing subscribers aren't affected.

DESTRUCTIVE. Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.

Deletes the feature attachment to a product

DESTRUCTIVE. Removes the currently applied discount on a subscription. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Deletes an item from the subscription. Removing a subscription item from a subscription will not cancel the subscription. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: delete a reader configuration profile. Readers using it fall back to the account default, so tipping prompts and display settings change at every one of them at once. Re-creating the profile does not re-attach the readers.

DESTRUCTIVE: delete a Terminal location. Every reader registered there is orphaned and stops taking payments until it is re-registered against another location -- which needs somebody physically at the device. Re-creating the location does not re-attach the readers.

DESTRUCTIVE: de-register a physical reader. The device stops being usable for payments immediately and somebody has to be standing next to it with its registration code to add it back -- stripe_create_terminal_reader needs a code read off the screen, which an agent cannot obtain remotely.

DESTRUCTIVE. You can also delete webhook endpoints via the webhook endpoint management page of the Stripe dashboard. Silently breaks whatever integration was consuming that endpoint. Agentic Fabriq cannot recreate it: webhook endpoint creation is not exposed (E1 -- the create response is the only place Stripe ever returns the signing secret). Read stripe_list_webhook_endpoints and record the URL and enabled_events before deleting, then have a human recreate it in the dashboard.

DESTRUCTIVE. Detaches a PaymentMethod object from a Customer. Detachment is permanent and irreversible — once detached, a PaymentMethod can no longer be used for payments or re-attached to a Customer. Removes a saved card from a customer, so future invoices and subscriptions on that card will fail. The inverse is stripe_attach_payment_method with the same payment method id, which works as long as the PaymentMethod object still exists. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: sever the link between this account and the customer's bank. Balances, ownership and transactions stop updating immediately, and anything that pays by bank debit from it will start failing. THE UNDO IS NOT AGENTIC FABRIQ'S TO GIVE: reconnecting requires the END USER to authenticate at their bank again in a Financial Connections session, which no action here can trigger on their behalf. Treat it as one-way.

DESTRUCTIVE: sever the link between this account and the customer's bank. Balances, ownership and transactions stop updating immediately, and anything that pays by bank debit from it will start failing. THE UNDO IS NOT AGENTIC FABRIQ'S TO GIVE: reconnecting requires the END USER to authenticate at their bank again in a Financial Connections session, which no action here can trigger on their behalf. Treat it as one-way. This is the /linked_accounts spelling of the same Stripe object as stripe_refresh_financial_connection_account.

Download the PDF of a FINALIZED quote. Stripe answers with a file rather than JSON, so Agentic Fabriq returns the content type, the size in bytes and the document base64-encoded, and REFUSES anything over 5 MB rather than pushing a large binary into an agent's context. Only finalized quotes have a PDF.

Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization. Asks Radar to score a payment. It records an evaluation but changes no money and blocks nothing on its own.

DESTRUCTIVE. Expires a credit grant. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. A Checkout Session can be expired when it is in one of these statuses: open After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired. Ends an open Checkout Session so its public URL stops accepting payment. Terminal -- an expired session cannot be reopened -- but it is the SAFE direction: Agentic Fabriq exposes no way to create one of these public URLs (E5), only to take one down. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you'd like to finalize a draft invoice manually, you can do so using this method. Finalizing moves a draft to `open` and makes it real: the number is assigned, the customer can see it, and depending on collection_method Stripe may attempt payment automatically. The inverse is stripe_void_invoice, which is terminal -- so this is the point of no easy return, not the payment. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Finalizes the quote. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Finds a tax association object by PaymentIntent id.

Identify the Stripe account this connection authenticates as: its id (acct_…), display name, country, default currency and whether it can accept charges. START HERE. The result carries `stripe_mode`, which is either "test" (a sandbox — no card network is contacted and no money is real) or "live" (real customers, real money). Test-mode and live-mode objects are completely separate, so a live customer id is "not found" to a test connection and vice versa. Every Stripe result carries this field; check it before acting on any amount.

Retrieves an account or customer tax_id object.

Retrieve an apple pay domain.

Retrieves the details of an application fee that your account has collected. The same information is returned when refunding the application fee.

By default, you can see the 10 most recent refunds stored directly on the application fee object, but you can also retrieve details about a specific refund stored on the application fee.

Read the Stripe balance: funds available for payout and funds still pending, listed per currency. Amounts are integers in the currency's SMALLEST UNIT — {"amount": 1250, "currency": "usd"} is $12.50, not $1250. Never present a Stripe amount without dividing by the currency's minor unit.

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path /v1/balance/history/:id.

Retrieves balance settings for a given connected account. Related guide: Making API calls for connected accounts

Retrieves the balance transaction with the given ID. Note that this endpoint previously used the path /v1/balance/history/:id.

Retrieves a billing alert given an ID

Retrieves the credit balance summary for a customer.

Retrieves a credit balance transaction.

Retrieves a credit grant.

Retrieves a billing meter given an ID.

Retrieves a configuration that describes the functionality of the customer portal.

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information. The same information is returned when creating or refunding the charge.

Retrieve a dispute for a specified charge.

Retrieves the details of an existing refund.

Retrieves a Checkout Session object.

Retrieves the details of a Climate order object with the given ID.

Retrieves the details of a Climate product with the given ID.

Retrieves a Climate supplier object.

Retrieves an existing ConfirmationToken object

Retrieves the details of an account.

Retrieve a specified external account for a given account.

Retrieves information about the specified Account Capability.

Retrieve a specified external account for a given account.

Retrieves an existing person.

Retrieves an existing person.

Returns a Country Spec for a given Country code.

Retrieves the coupon with the given ID.

Retrieves the credit note object with the given identifier.

Get one Stripe customer by id, including email, name, account balance, currency, default payment method and metadata. Get an id from stripe_list_customers — customer ids are not guessable (they look like cus_QxYz123AbCdEf).

Retrieves a specific customer balance transaction that updated the customer's balances.

By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.

You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.

Retrieves a customer's cash balance.

Retrieves a specific cash balance transaction, which updated the customer's cash balance.

Retrieves the discount currently applied to a customer, if any. Answers "why is this customer being billed less than list price" -- returns the coupon or promotion code behind the reduction, what it takes off, and when it stops applying. A customer with no active discount is not an error; the result is simply empty. Read-only: the inverse of stripe_delete_customer_discount, which is what actually removes it.

Retrieves a PaymentMethod object for a given Customer.

Retrieve a specified source for a given customer.

Retrieves the subscription with the given ID.

Retrieves the discount currently applied to one subscription, if any. Distinct from stripe_get_customer_discount: a discount can sit on the CUSTOMER, in which case it reduces every subscription they hold, or on a SINGLE SUBSCRIPTION, in which case it reduces only that one. Reading the customer-level discount will not show you a subscription-level one, so when a single line on an invoice looks wrong this is the call that explains it. A subscription with no discount of its own returns empty rather than erroring.

Retrieves the tax_id object with the given identifier.

Retrieves the dispute with the given ID. evidence_details.due_by (the evidence deadline), reason, and the evidence already submitted are only on this single object, not on the list row. Read it before touching stripe_update_dispute.

Retrieve an active entitlement

Retrieves one entitlement feature by id -- its name, its permanent lookup_key, and whether it is still active. Answers "does this capability exist and what is it called" before attaching it to a product or checking a customer's entitlements. Read-only.

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead. Retrieves the exchange rates from the given currency to every supported currency.

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

Retrieves the file link with the given ID.

Retrieves the details of an Financial Connections Account.

Retrieves the details of a Financial Connections Session

Retrieves the details of a Financial Connections Transaction

Retrieves a ForwardingRequest object.

Retrieves an existing VerificationReport

Retrieves the details of a VerificationSession that was previously created. When the session status is requires_input, you can use this method to retrieve a valid client_secret or url to allow re-submission.

Retrieves the invoice with the given ID. hosted_invoice_url, invoice_pdf, attempt_count and the last payment failure reason are on this single object, not on the stripe_list_invoices row.

Retrieves the invoice payment with the given ID.

Retrieves an invoice rendering template with the given ID. It by default returns the latest version of the template. Optionally, specify a version to see previous versions.

Retrieves the invoice item with the given ID.

Retrieves an Issuing Authorization object.

Retrieves an Issuing Card object.

Retrieves an Issuing Cardholder object.

Retrieves an Issuing Dispute object.

Retrieves a personalization design object.

Retrieves a physical bundle object.

Retrieves an Issuing Settlement object.

Retrieves an Issuing Token object.

Retrieves an Issuing Transaction object.

Retrieves the details of a Financial Connections Session

Retrieves the details of an Financial Connections Account.

Retrieves a Mandate object.

Retrieves a Payment Attempt Record with the given ID

Get one PaymentIntent by id, including amount, currency, status, the last payment error if it failed, and the charge it produced. Use `latest_charge` from the result as the charge id for a refund.

Retrieve a payment link.

Retrieves a PaymentMethod object attached to the StripeAccount. To retrieve a payment method attached to a Customer, you should use Retrieve a Customer's PaymentMethods

Retrieve payment method configuration

Retrieves the details of an existing payment method domain.

Retrieves a Payment Record with the given ID

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

Retrieves the plan with the given ID.

Retrieves the price with the given ID.

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

Retrieves a product_feature, which represents a feature attachment to a product

Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use list with the desired code.

Retrieves the quote with the given ID.

Retrieves the details of an early fraud warning that has previously been created. Please refer to the early fraud warning object reference for more details.

Retrieves a ValueList object.

Retrieves a ValueListItem object.

Retrieves the details of an existing refund.

Retrieves the details of an existing Report Run.

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

Retrieves a Review object.

Retrieves the details of a SetupIntent that has previously been created. Client-side retrieval using a publishable key is allowed when the client_secret is provided in the query string. When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.

Returns the shipping rate object with the given ID.

Retrieves the details of an scheduled query run.

Retrieves an existing source object. Supply the unique source ID from a source creation request and Stripe will return the corresponding up-to-date source object information.

Retrieves a new Source MandateNotification.

Retrieve an existing source transaction object. Supply the unique source ID from a source creation request and the source transaction ID and Stripe will return the corresponding up-to-date source object information.

Retrieves the subscription with the given ID. Read this BETWEEN finding a subscription and cancelling it: the list row does not carry the full item set, the current period end or pause_collection, and cancelling off a stale list row is how the wrong subscription gets stopped.

Retrieves the subscription item with the given ID.

Retrieves the details of an existing subscription schedule. You only need to supply the unique subscription schedule identifier that was returned upon subscription schedule creation.

Retrieves a Tax Calculation object, if the calculation hasn't expired.

Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.

Retrieves a tax rate with the given ID

Returns a Tax Registration object.

Retrieves Tax Settings for a merchant.

Retrieves a Tax Transaction object.

Retrieves a Configuration object.

Retrieves a Location object.

Retrieves a Reader object.

Retrieves the token with the given ID. Returns the token's card metadata -- brand, last4, expiry, country -- never the card number. Agentic Fabriq does not expose token CREATION (E8: it would require a raw card number in the agent's prompt).

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

Retrieves a DebitReversal object.

Retrieves the details of a FinancialAccount.

Retrieves Features information associated with the FinancialAccount.

Retrieves the details of an existing InboundTransfer.

Retrieves the details of an existing OutboundPayment by passing the unique OutboundPayment ID from either the OutboundPayment creation request or OutboundPayment list.

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.

Retrieves the details of an existing ReceivedDebit by passing the unique ReceivedDebit ID from the ReceivedDebit list

Retrieves the details of an existing Transaction.

Retrieves a TransactionEntry object.

Retrieves the webhook endpoint with the given ID. The retrieve response does NOT contain the signing secret -- Stripe returns that only from the create call, which Agentic Fabriq does not expose. This read is the inventory: which URLs already receive this account's events.

Returns a list of tax IDs.

List apple pay domains.

You can see a list of the refunds belonging to a specific application fee. Note that the 10 most recent refunds are always available by default on the application fee object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.

Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first. The previous name of this endpoint was "Balance history," and it used the path /v1/balance/history.

Returns a list of transactions that have contributed to the Stripe account balance (for example, charges, transfers, and so on). The transactions return in sorted order, with the most recent transactions appearing first. The previous name of this endpoint was "Balance history," and it used the path /v1/balance/history. stripe_get_balance returns a snapshot with no history; THIS is the endpoint that reconciles a payout to the charges, fees, refunds and adjustments inside it. Filter by payout to answer "what was in this deposit". Amounts are in the currency's smallest unit.

Lists billing active and inactive alerts

Retrieve a list of credit balance transactions.

Retrieve a list of credit grants.

Retrieve a list of billing meter event summaries.

Retrieve a list of billing meters.

Returns a list of configurations that describe the functionality of the customer portal.

You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional refunds.

List charges, newest first — the settled record of money actually taken, with amount, currency, whether it is already refunded, how much has been refunded, and the card's brand and last four digits. THIS IS WHERE A REFUND STARTS: stripe_create_refund addresses a charge id (ch_…). Card details in the result are the last four digits only; never repeat them unnecessarily.

When retrieving a Checkout Session, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Returns a list of Checkout Sessions.

Lists all Climate order objects. The orders are returned sorted by creation date, with the most recently created orders appearing first.

Lists all available Climate product objects.

Lists all available Climate supplier objects.

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

List external accounts for an account.

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.

Returns a list of accounts connected to your platform via Connect. If you're not a platform, the list is empty.

Lists all Country Spec objects available in the API.

Returns a list of your coupons.

When retrieving a credit note, you'll get a lines property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Returns a list of credit notes.

Returns a list of transactions that updated the customer's balances.

You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.

You can see a list of the cards belonging to a customer. Note that the 10 most recent sources are always available on the Customer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.

Returns a list of transactions that modified the customer's cash balance.

Returns a list of PaymentMethods for a given Customer Answers "why did the renewal fail / which card is on file / is it expired". Returns brand, last4, exp_month and exp_year only -- never a full card number. Do not repeat the last four digits unless the task needs them.

List sources for a specified customer.

You can see a list of the customer's active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.

Returns a list of tax IDs for a customer.

List Stripe customers, newest first, at most 100 per call, with a `has_more` flag and cursor paging. Pass `email` for an EXACT-match lookup — Stripe does not match partially or case-insensitively — which is how you turn a known address into a customer id (cus_…). Results contain personal data: names, email addresses and billing addresses. Do not repeat more of it than the task needs.

Returns a list of your disputes. Disputes are deadline-driven: evidence_details.due_by is a hard cutoff and a missed one forfeits the money automatically. This is the read that surfaces them. Note the due date and the reason live on the SINGLE dispute object (stripe_get_dispute), not on the list row.

Retrieve a list of active entitlements for a customer

Retrieve a list of features

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header). This is the account's activity log and it is how an agent verifies its own writes actually landed -- "did the refund settle", "what changed since yesterday" -- without polling every list endpoint. It is also the honest audit read for a connector whose writes are irreversible. Events expire after 30 days.

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead. Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.

Returns a list of file links.

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top. Metadata only. The file bytes live on files.stripe.com behind a separate credential, and Agentic Fabriq exposes no file upload and no file-link creation (E5: a file link is an unauthenticated public download URL for dispute evidence and identity documents).

Lists all owners for a given Account

Returns a list of Financial Connections Account objects.

Returns a list of Financial Connections Transaction objects.

Lists all ForwardingRequest objects.

List all verification reports.

Returns a list of VerificationSessions Contains government-ID verification outcomes for real people. Read only what the task needs and repeat none of it.

When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.

List all templates, ordered by creation date, with the most recently created template appearing first.

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.

List invoices, newest first, optionally filtered by customer, subscription or status. Statuses are draft, open, paid, uncollectible and void; `open` is the one that means owed and unpaid. Invoice amounts are in the currency's smallest unit.

Returns a list of Issuing Authorization objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Lists all Issuing Token objects for a given card.

Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Lists all owners for a given Account

Returns a list of Financial Connections Account objects.

List all the Payment Attempt Records attached to the specified Payment Record.

Lists all LineItems of a given PaymentIntent.

List PaymentIntents, newest first — the payment ATTEMPTS, successful or not, with amount, currency, status and customer. A PaymentIntent is the attempt; the settled record of money actually taken is a CHARGE (stripe_list_charges), and a refund addresses a charge id. Amounts are in the currency's smallest unit.

When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

Returns a list of your payment links.

List payment method configurations

Lists the details of existing payment method domains.

Returns a list of all PaymentMethods.

List all the Payment Records for a given merchant.

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

Returns a list of your plans.

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false. A subscription line item is a bare price_... id. Without this every subscription and invoice answer an agent gives is opaque ids rather than "Pro plan, $49/mo". unit_amount is in the currency's smallest unit.

Retrieve a list of features for a product

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first. The other half of turning a price_... id into something a human recognises.

Returns a list of your promotion codes.

When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

When retrieving a quote, there is an includable computed.upfront.line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.

Returns a list of your quotes.

Returns a list of early fraud warnings. An early fraud warning is the issuer telling you a dispute is coming before the cardholder files it. Refunding at this point usually avoids the dispute fee.

Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

List refunds already issued, newest first, optionally narrowed to one charge or payment. CALL THIS BEFORE stripe_create_refund: it is the only way to see how much of a charge has already been returned, and Stripe will happily accept a further refund up to the charge's remaining balance. Two agents each 'refunding the order' produces two refunds.

Returns a list of Report Runs, with the most recent appearing first. Reads report runs a human already created. Agentic Fabriq does not expose report-run CREATION: a report run is a full-ledger export of every balance transaction, payout or customer row for an arbitrary date range.

Returns a full list of Report Types.

Returns a list of Review objects that have open set to true. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Returns a list of SetupAttempts that associate with a provided SetupIntent.

Returns a list of SetupIntents.

Returns a list of your shipping rates.

Returns a list of scheduled query runs.

List source transactions for a given source.

Returns a list of your subscription items for a given subscription.

Retrieves the list of your subscription schedules.

List subscriptions with status, current period, price and customer. IMPORTANT: Stripe returns only ACTIVE subscriptions unless you set `status` explicitly — pass status=all to include cancelled and past-due ones, or a subscription an agent 'cannot find' may simply be cancelled.

Retrieves the line items of a tax calculation as a collection, if the calculation hasn't expired.

A list of all tax codes available to add to Products in order to allow specific tax calculations.

Returns a list of your tax rates. Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first.

Returns a list of Tax Registration objects.

Retrieves the line items of a committed standalone transaction as a collection.

Returns a list of Configuration objects.

Returns a list of Location objects.

Returns a list of Reader objects.

Returns a list of top-ups.

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

Returns a list of CreditReversals.

Returns a list of DebitReversals.

Returns a list of FinancialAccounts.

Returns a list of InboundTransfers sent from the specified FinancialAccount.

Returns a list of OutboundPayments sent from the specified FinancialAccount.

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

Returns a list of ReceivedCredits.

Returns a list of ReceivedDebits.

Retrieves a list of TransactionEntry objects.

Retrieves a list of Transaction objects.

Returns a list of your webhook endpoints. A security read: which external URLs already receive a copy of every event on this account.

DESTRUCTIVE. Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes. The bad-debt write-off, and the safest of the AR writes: an uncollectible invoice can still be paid afterwards (stripe_pay_invoice), so unlike voiding it is reversible. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE and ONE-WAY: move an existing subscription from Stripe's classic billing mode to flexible billing. Stripe publishes no reverse migration -- once a subscription is on flexible mode it stays there -- and the change affects how proration, credits and invoice line items are calculated for every future cycle of a REAL subscription. `billing_mode` is required. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so. This TAKES money: it charges the customer's stored payment method for the invoice amount. It is bounded -- it can only ever collect what the merchant already billed on a real invoice object -- but it lands on the opposite side of most people's intuition from a refund, so read stripe_get_invoice and confirm the amount and the customer before calling it. There is no un-pay; the recovery is a refund, which does not return the processing fee. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Get a preview of a credit note without creating it.

When retrieving a credit note preview, you'll get a lines property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.

At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

DESTRUCTIVE: hand an existing PaymentIntent to a physical reader and prompt the person standing at it to present a card. THIS TAKES REAL MONEY from a real cardholder. The amount is not this call's to choose -- it comes from the PaymentIntent, which Agentic Fabriq cannot create (that is E4-refused), so the ceiling was set by the merchant's own system. The undo is a refund, which does not return the processing fee. stripe_cancel_terminal_reader_action aborts it while the prompt is still on screen. Needs confirm_live_mode=true on a live connection.

Hand a SetupIntent to a reader so the customer can present a card to be SAVED rather than charged. No money moves now; it authorises later billing, which is why it needs confirm_live_mode=true on a live connection. allow_redisplay records whether the saved card may be shown back to the customer, and Stripe requires it.

When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.

DESTRUCTIVE AND PERMANENT: erase the personal data collected in an identity verification session -- the ID images, the extracted name, date of birth and document number. Stripe describes this as irreversible and nobody, including Stripe support, can restore it. That data may be evidence a merchant is legally required to RETAIN for KYC or AML purposes, so redacting it can create a compliance problem rather than solving one. It is the right tool for a deletion request under privacy law and the wrong tool for tidying up. Redaction also cancels the session.

Ask Stripe to pull fresh data from the customer's bank for one linked account -- balances, ownership or transactions, named in `features`. Nothing is charged to the customer and nothing is destroyed; the refresh is asynchronous, so read the account again afterwards to see whether it succeeded. Some banks rate-limit refreshes and Stripe bills the platform per refresh on some plans.

Ask Stripe to pull fresh data from the customer's bank for one linked account -- balances, ownership or transactions, named in `features`. Nothing is charged to the customer and nothing is destroyed; the refresh is asynchronous, so read the account again afterwards to see whether it succeeded. Some banks rate-limit refreshes and Stripe bills the platform per refresh on some plans. This is the /linked_accounts spelling of the same Stripe object as stripe_refresh_financial_connection_account.

DESTRUCTIVE. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. When you create a new refund, you must specify either a Charge or a PaymentIntent object. This action refunds a previously created charge that's not refunded yet. Funds are refunded to the credit or debit card that's originally charged. You can optionally refund only part of a charge. You can repeat this until the entire charge is refunded. After you entirely refund a charge, you can't refund it again. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE: refund an in-person charge at the reader, with the cardholder present to tap the same card (which is what interac_present and some other in-person methods require). THIS MOVES REAL MONEY out of the balance and there is no un- refund. Bounded by the original charge's remaining amount. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: mark a connected account as rejected for fraud, terms-of-service violation or another reason, which immediately stops its charges and payouts. Unlike deletion this is REVERSIBLE -- stripe_unreject_connected_account ships in the same migration and puts the account back -- so reject rather than delete whenever the answer might change. `reason` is required and is recorded on the account permanently. Needs confirm_live_mode=true on a live connection because it stops real money moving.

DESTRUCTIVE. Releases the subscription schedule immediately, which will stop scheduling of its phases, but leave any existing subscription in place. A schedule can only be released if its status is not_started or active. If the subscription schedule is currently associated with a subscription, releasing it will remove its subscription property and set the subscription's ID to the released_subscription property. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Removes multiple line items from an invoice. This is only possible when an invoice is still a draft. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Record a payment that was taken somewhere OTHER than Stripe -- a second processor, a bank transfer, cash -- so that Stripe's reporting sees the whole picture. This moves no money and creates nothing the customer can see: it is bookkeeping. amount_requested, initiated_at and payment_method_details are required. Follow it with stripe_report_payment_attempt_guaranteed or stripe_report_payment_attempt_failed as the external processor settles.

Add another attempt to an existing payment record -- a retry against the external processor. Bookkeeping only: no money moves and nothing is charged. initiated_at is required and is the moment the external attempt began, not the moment this call is made.

Record that the latest attempt on an external payment record was canceled, with the timestamp it happened (canceled_at, required). Bookkeeping only -- no money moves, nothing is charged or refunded, and no customer-visible object changes. It is what makes Stripe's reporting agree with the other processor's.

Record that the latest attempt on an external payment record was failed, with the timestamp it happened (failed_at, required). Bookkeeping only -- no money moves, nothing is charged or refunded, and no customer-visible object changes. It is what makes Stripe's reporting agree with the other processor's.

Record that the latest attempt on an external payment record was guaranteed, with the timestamp it happened (guaranteed_at, required). Bookkeeping only -- no money moves, nothing is charged or refunded, and no customer- visible object changes. It is what makes Stripe's reporting agree with the other processor's.

Attach customer, shipping or descriptive detail to a payment record without asserting any outcome. Use it when the extra context arrived after the attempt was reported. Bookkeeping only.

Record a refund that was issued through the external processor, so the Stripe payment record reflects it. THIS DOES NOT REFUND ANYTHING -- it does not touch a Stripe balance and it does not return money to a customer; stripe_create_refund is the action that moves money. outcome and processor_details are required.

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn't generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. The inverse of pausing collection on a subscription (pause_collection via stripe_update_subscription). Billing restarts, so on a live connection this is money-gated like every other billing write. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Partially or fully reverses a previously created Transaction. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Search for charges you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. This is the only way to get from an order id stored in metadata to a charge, which is where a refund starts. Without it the refund workflow begins with an unbounded stripe_list_charges scan. Same eventual-consistency caveat as every Stripe search: an object created seconds ago may not be indexed yet.

Search for customers you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. Use this rather than stripe_list_customers when you have an email, a name, a phone number or a metadata value: the list endpoint's email filter is EXACT-match, case- and whitespace-sensitive, so a real person's address usually misses. Example query: email:'jane@example.com' OR metadata['order_id']:'1234'. Stripe's search index is eventually consistent -- normally under a minute behind a write, occasionally up to an hour -- so an object created seconds ago may not be findable yet. Search is not available to merchants in India.

Search for invoices you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. Filters invoices by number, customer, status, total and metadata. Same eventual-consistency caveat as every Stripe search.

Search for PaymentIntents you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. The only filter on PaymentIntent status -- stripe_list_payment_intents has none. Same eventual-consistency caveat as every Stripe search.

Search for prices you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. Same eventual-consistency caveat as every Stripe search.

Search for products you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. Same eventual-consistency caveat as every Stripe search.

Search for subscriptions you've previously created using Stripe's Search Query Language. Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India. Same eventual-consistency caveat as every Stripe search.

DESTRUCTIVE. Stripe will automatically send invoices to customers according to your subscriptions settings. However, if you'd like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email. Requests made in test-mode result in no emails being sent, despite sending an invoice.sent event. Emails the invoice to the customer from the merchant's own domain. The recipient is the customer on the invoice -- you cannot choose an address -- but an email cannot be recalled once sent, so confirm the invoice is the right one first. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Show a cart -- line items, tax and total -- on the reader's screen so the customer can see what they are about to pay for. It displays; it does not charge. stripe_cancel_terminal_reader_action clears it.

DESTRUCTIVE and one-way: send the dispute and its evidence to the card network. Nothing can be edited afterwards and the submission cannot be withdrawn -- an under-evidenced dispute submitted early is simply lost. Read the dispute first and confirm the evidence is complete. Needs confirm_live_mode=true on a live connection.

Turn on ongoing data refreshes for a linked bank account, so Stripe keeps transactions flowing without a manual refresh each time. Its inverse is stripe_unsubscribe_financial_connection_account and both ship together. Subscriptions are billed per account on some plans, which is the only cost here -- no customer money moves.

Unarchive an invoice rendering template so it can be used on new Stripe objects again.

Clear a pending cancellation: sets cancel_at_period_end back to false on a subscription that is still active but scheduled to stop at the end of the current period. This is the undo for stripe_cancel_subscription's DEFAULT form, which that tool's own description advertises as reversible. It cannot rescue a subscription that was cancelled with immediately=true -- once status is 'canceled' Stripe has no un-cancel and the only route back is a new subscription with a new billing anchor. Billing resumes on the existing schedule. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Undo stripe_reject_connected_account: clear the rejection so the account can be verified and take payments again. This is the inverse half of the pair and it is why rejecting is preferable to deleting. It does NOT re-verify the account -- Stripe re-runs its own checks and the account may land back in a requirements-due state, which stripe_get_connected_account will show. Needs confirm_live_mode=true on a live connection because it restarts real money movement.

Stop the ongoing refreshes turned on by stripe_subscribe_financial_connection_account. The account stays linked and readable -- this is not a disconnect -- so it is fully reversible by subscribing again.

DESTRUCTIVE. Updates the specified application fee refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Updates balance settings for a given connected account. Related guide: Making API calls for connected accounts Changes the account's payout schedule and debit behaviour for ALL future money movement, not one transaction. Read stripe_get_balance_settings first and record the previous values -- that read is the only undo.

Updates a credit grant. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates a billing meter.

Change which self-service actions the customer portal offers, or set active=false to retire a configuration. Every change applies to every customer who opens the portal next, immediately. Fully reversible.

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided will be left unchanged. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Update a specified refund. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates a Checkout Session object. Related guide: Dynamically update a Checkout Session On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Change the named beneficiary or the metadata on a carbon- removal order. It cannot change the amount or the supplier, so it spends nothing -- cancel and re-order for that.

Change a connected account's business profile, company or individual details, settings, requested capabilities and metadata -- the write that clears a verification requirement Stripe is blocking payouts on. Read stripe_get_connected_account first: it lists exactly which fields are currently_due, so this becomes a targeted correction rather than a guess. Refuses external_account and bank_account for the same reason the create does.

Request a capability for a connected account (requested=true) or withdraw the request (requested=false) -- card_payments, transfers, us_bank_account_ach_payments and the rest. Requesting one does not grant it: Stripe moves it to pending and may add verification requirements, which stripe_get_connected_account_capability reports. Fully reversible in both directions, which is why this is not destructive.

Correct a person on a connected account: name, date of birth, address, contact details or relationship. This is the write that clears a person-level verification requirement, and stripe_get_connected_account_person names exactly which field Stripe is waiting for. Government identification numbers are refused as arguments for the reason the create gives. This is the /people spelling of the same Stripe endpoint as stripe_update_connected_account_person.

Correct a person on a connected account: name, date of birth, address, contact details or relationship. This is the write that clears a person-level verification requirement, and stripe_get_connected_account_person names exactly which field Stripe is waiting for. Government identification numbers are refused as arguments for the reason the create gives.

Updates the metadata of a coupon. Other coupon details (currency, duration, amount_off) are, by design, not editable.

Updates an existing credit note. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Correct a customer's contact details: email, name, phone, address, description and metadata, and NOTHING ELSE. Fixing a typo in a customer's email is the most common non-money support write on Stripe, and it is reversible by construction because stripe_get_customer shows the old value first -- read it before you write, so you can put it back. Agentic Fabriq REFUSES the other fields of this endpoint at the connector: `balance` (a negative integer there is an unlimited credit against every future invoice), `default_source` and `default_card` (they silently redirect which stored card gets billed) and `invoice_settings` (same, one level down). Those are separate operations Agentic Fabriq does not expose, not arguments this tool quietly ignores: passing one is an error naming the reason.

Correct the details Stripe stores alongside a saved bank account on a customer: cardholder name, billing address, and the expiry month and year. This is the fix for a declined recurring charge whose cause is an address mismatch or a card the customer has already renewed -- it does NOT change the card number, and it cannot: the PAN and CVC are not arguments of this endpoint at all. Needs confirm_live_mode=true on a live connection because it edits the instrument real invoices are charged to.

Correct the details Stripe stores alongside a saved card on a customer: cardholder name, billing address, and the expiry month and year. This is the fix for a declined recurring charge whose cause is an address mismatch or a card the customer has already renewed -- it does NOT change the card number, and it cannot: the PAN and CVC are not arguments of this endpoint at all. Needs confirm_live_mode=true on a live connection because it edits the instrument real invoices are charged to.

Correct the details Stripe stores alongside a saved source on a customer: cardholder name, billing address, and the expiry month and year. This is the fix for a declined recurring charge whose cause is an address mismatch or a card the customer has already renewed -- it does NOT change the card number, and it cannot: the PAN and CVC are not arguments of this endpoint at all. Needs confirm_live_mode=true on a live connection because it edits the instrument real invoices are charged to.

DESTRUCTIVE. Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically. Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. Submitting evidence is a legal act on the merchant's behalf: the evidence goes to the issuing bank and the card network, and passing submit=true is FINAL -- there is no resubmission and no correction. Read stripe_get_dispute first for evidence_details.due_by and the fields the network actually wants. Leaving submit unset saves a draft, which is the safe way to stage evidence for a human to send. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Update a feature's metadata or permanently deactivate it.

Change what an identity verification session asks for -- document versus ID number, matching options, provided details -- while it is still requires_input. Nothing is charged and no personal data is returned by this call. Once the session is processing or verified Stripe refuses the change.

Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable. If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on, sending reminders for, or automatically reconciling invoices, pass auto_advance=false. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice's line item is only possible before the invoice is finalized. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it's attached to is closed. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Attach metadata to a card authorization. It cannot approve, decline or change the amount -- those are separate actions -- so nothing moves.

DESTRUCTIVE: change an issued card's status or spending controls. status=canceled is TERMINAL -- Stripe has no un- cancel and the cardholder needs a new card with a new number; status=inactive is the reversible way to stop a card, and it is what to reach for first. Tightening spending_controls is the bounded way to reduce exposure without breaking the card. The PIN is refused (E8). Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE: change a cardholder's contact details, spending controls or status. status=blocked stops EVERY card that cardholder holds at once -- it is reversible with status=active, which is why this is destructive rather than terminal. Cardholder-level spending_controls apply across all their cards and are the widest lever here. Government identification numbers are refused as arguments (E8).

Add or correct the evidence on an unsubmitted issuing dispute. Only possible before submission -- once stripe_submit_issuing_dispute has run, the network has it and this endpoint stops accepting changes.

Change a physical-card design's logo, carrier text, name or lookup key. Editing a design that Stripe has already approved sends it back for review, which pauses new physical card orders using it -- reversible, but not instant.

Attach metadata to a card-network settlement record. Reconciliation bookkeeping only; no money moves.

DESTRUCTIVE: change the status of a digital wallet token (Apple Pay, Google Pay) provisioned from an issued card. status=deleted is TERMINAL -- the wallet credential is gone and the cardholder has to re-provision the card on their device; status=suspended is the reversible way to stop it, and status=active brings a suspended token back.

Attach metadata to a settled card transaction. It cannot change the amount or reverse anything.

Updates multiple line items on an invoice. This is only possible when an invoice is still a draft. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Annotate a PaymentIntent that already exists: description, metadata, receipt_email, shipping and the customer it is attached to. Same narrowing as stripe_update_charge, and for the same reason -- this one endpoint carries both the safest write on the surface (a metadata tag) and the ones that change what a later capture will take. Agentic Fabriq REFUSES those individually rather than ignoring them, and each refusal names its reason. Needs confirm_live_mode=true on a live connection because the object it edits is a real payment.

Updates a payment link. Set `active` to false to take a public payment link down. Agentic Fabriq exposes no way to CREATE a payment link (E5: a public, indexable URL under the merchant's brand that collects card data from anyone who visits), only to deactivate and reactivate one a human made. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Turn payment methods on or off in an existing configuration, or set active=false to retire it. Turning a method off means customers already mid-checkout stop being offered it; nothing already paid is affected. Fully reversible.

Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan's ID, amount, currency, or billing cycle.

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged.

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Updates the specified promotion code by setting the values of the parameters passed. Most fields are, by design, not editable.

A quote models prices and services for a customer. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don't provide remain unchanged. This request only accepts metadata as an argument. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Change a SetupIntent that has not completed: which customer it belongs to, its description, metadata, the payment-method types it accepts, or the stored payment method it points at. Nothing is charged. Inline payment_method_data is refused because it carries raw card details.

Updates an existing shipping rate object.

Update a Source object -- the legacy payment-instrument API Stripe has deprecated in favour of PaymentMethods. Kept because accounts created before the change still have live Sources attached to real subscriptions. It can change the mandate, the owner details and the order, but not the underlying card or bank number. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Updates an existing subscription to match the specified parameters. When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes. To preview how the proration is calculated, use the create preview endpoint. By default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they'll be billed 100 immediately. Changing items or price changes what the customer pays EVERY period, and the true cost of a mistake is amount x remaining periods -- a number no single call can see and no per-call amount limit can express. Set proration_behavior deliberately: the default prorates and issues an immediate charge or credit. Read stripe_get_subscription first. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Updates the plan or quantity of an item on a current subscription. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Updates an existing subscription schedule. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates an existing tax rate.

Updates an existing Tax Registration object. A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

DESTRUCTIVE. Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set. Account-wide Stripe Tax configuration. Read stripe_get_tax_settings first and record the previous values -- that read is the only undo.

Change a reader configuration profile. NOTE what tipping settings do: they change the amounts suggested to customers at every reader on this configuration, which changes what people are asked to pay, even though no charge happens here. Fully reversible.

Change a location's address, display name or configuration overrides. Fully reversible; nothing is charged.

Rename a reader or change its metadata. Nothing about payments changes and it is fully reversible.

Updates the metadata of a top-up. Other top-up details are not editable by design. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only metadata as an argument. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

Rename a Treasury financial account or change its platform restrictions and features. NOTE that platform_restrictions can freeze inbound or outbound flows on the account -- reversible, but it stops money moving while it is set.

Turn Treasury features on or off for one financial account: card issuing, deposit insurance, ACH and wire addresses, inbound transfers, outbound payments and transfers. Turning a feature ON widens what the account can do with money; turning it off narrows it. Both directions work, so this is reversible, and Stripe may hold a feature in pending while it reviews.

Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint. Agentic Fabriq REFUSES the `url` field on this call (E2: a caller-chosen destination for a copy of every event on the account). What is editable here is enabled_events, description, metadata and disabled - which makes this the tool for muting a noisy or broken endpoint without deleting it, and the reversible alternative to stripe_delete_webhook_endpoint.

Confirm the two microdeposit amounts Stripe sent to a customer's bank account, which is what turns a stored bank account from unverified into chargeable. The customer reads the amounts off their statement and the agent relays them; too many wrong attempts and Stripe locks the bank account permanently, so do not guess. Needs confirm_live_mode=true on a live connection because it enables real debits.

The /sources spelling of stripe_verify_customer_bank_account: confirm the microdeposit amounts on a stored bank-account source so it can be charged. Stripe publishes both paths against the same object. Wrong amounts repeated lock the source. Needs confirm_live_mode=true on a live connection.

Finish an ACH or bank-debit payment by confirming the two small deposits Stripe sent to the customer's bank account, using either the two amounts or the six-digit descriptor code the customer reads off their statement. The customer supplies those numbers; the agent only relays them. Getting them wrong repeatedly locks the verification and the payment has to be started again. Needs confirm_live_mode=true on a live connection because it completes a real payment.

Finish storing a bank account by confirming the two microdeposit amounts, or the six-digit descriptor code, that the customer reads off their statement. The customer supplies the numbers; repeated wrong attempts lock the verification and the setup has to start again. Needs confirm_live_mode=true on a live connection.

Confirm the microdeposit amounts on a legacy Source so it can be charged. The customer reads the values off their bank statement; repeated wrong values lock the source permanently. Needs confirm_live_mode=true on a live connection.

DESTRUCTIVE. Voids a credit grant. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Marks a credit note as void. Learn more about voiding credit notes. The inverse of stripe_create_credit_note. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.

DESTRUCTIVE. Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. Voiding is TERMINAL: Stripe documents a voided invoice as impossible to un-void. The nearest recovery is to create a new invoice from scratch, which loses the number, the history and the payment attempts. Prefer stripe_mark_uncollectible_invoice, which is reversible by paying the invoice afterwards. On a LIVE-mode connection this call is REFUSED unless you pass confirm_live_mode=true; check stripe_mode on any read result first. In test mode the flag is ignored.