Skip to main content

Stripe API Endpoints

Every Stripe API endpoint the Stripe integration calls, grouped by Stripe object, with how it authenticates, pages through results and stays within Stripe's rate limits.

Portal Info

Stripe accounts are managed in the Stripe Dashboard at https://dashboard.stripe.com. The same address serves live mode and test mode (or a test sandbox); the Dashboard's mode switch chooses which one you see. API keys are under Developers > API keys, and the webhook endpoint the integration registers is under Developers > Webhooks.

API Endpoints

The integration calls Stripe's REST API (Stripe's reference: https://docs.stripe.com/api). Requests send form-encoded parameters and receive JSON. Every call is made with Stripe API version 2026-09-30.endive, so a change to your Stripe account's default API version doesn't change how the integration behaves.

  • Base URL: https://api.stripe.com (the API Url setting; every path below starts with /v1).

  • Test mode: the same base URL. A test key (sk_test_ or rk_test_) reaches your account's test mode or test sandbox; a live key reaches live mode.

In the paths below, [Base URL] stands for https://api.stripe.com, and {Id} for the Stripe id of the object named.

Contents

Account Endpoints

Get the Account (GET)

Used by the connection check to prove the key, and to read the account's default currency and time zone (due dates are days on that clock).

[Base URL]/v1/account

Invoice Endpoints

Get an Invoice by Id (GET)

Used during TO iPaaS.com transfers to read an invoice with its payments.

[Base URL]/v1/invoices/{Id}?expand[]=payments

List an Invoice's Lines (GET)

Used to read a Stripe-made sale's lines beyond the first page the invoice carries.

[Base URL]/v1/invoices/{Id}/lines?limit=100&starting_after={LineId}

Search Invoices (GET)

Used to find the invoices this integration issued for an iPaaS.com transaction, by the metadata it writes on each invoice, for example when a transaction is deleted. Stripe's search can take up to a minute to show a new invoice.

[Base URL]/v1/invoices/search?query=metadata['{Key}']:'{Value}'&limit=20

List a Customer's Invoices (GET)

Used during FROM iPaaS.com transfers to find every invoice issued for a transaction, including one Stripe's search doesn't show yet, so a transaction never gets a second open invoice.

[Base URL]/v1/invoices?customer={CustomerId}&limit=100

Create an Invoice (POST)

Used during FROM iPaaS.com transfers to create the Stripe invoice for a transaction. Each create carries an Idempotency-Key, so a retried transfer never makes a second invoice.

[Base URL]/v1/invoices

Update an Invoice (POST)

Used to write the integration's own notes into an invoice's metadata, for example a warning to show on the transaction, or a mark before the integration voids an invoice it re-issues.

[Base URL]/v1/invoices/{Id}

Finalize an Invoice (POST)

Used to finalize a new invoice, which gives it its number and pay link.

[Base URL]/v1/invoices/{Id}/finalize

Send an Invoice (POST)

Used to ask Stripe to email a finalized invoice to the customer, when Stripe Emails Invoices is Yes.

[Base URL]/v1/invoices/{Id}/send

Void an Invoice (POST)

Used when a transaction is changed before payment (before the invoice is issued again), cancelled, deleted, or brought to a total of 0.

[Base URL]/v1/invoices/{Id}/void

Mark an Invoice Paid Outside Stripe (POST)

Used when a transaction is paid in full another way and Close Stripe Invoices Paid Elsewhere is Yes. It sends paid_out_of_band=true; no money moves.

[Base URL]/v1/invoices/{Id}/pay

Delete a Draft Invoice (DELETE)

Used when a transaction is sent again after an earlier attempt left its invoice as a draft: the draft is removed and a new invoice is issued.

[Base URL]/v1/invoices/{Id}

Invoice Item Endpoints

Create an Invoice Item (POST)

Used to add each line of a transaction, and the Tax, Shipping, Discount and Payment already received lines, to a new invoice.

[Base URL]/v1/invoiceitems

Invoice Payment Endpoints

List an Invoice's Payments (GET)

Used to read the payments recorded against an invoice.

[Base URL]/v1/invoice_payments?invoice={InvoiceId}&limit=100

Find the Invoice a Payment Paid (GET)

Used to find which invoice a Stripe payment belongs to.

[Base URL]/v1/invoice_payments?payment[type]=payment_intent&payment[payment_intent]={PaymentIntentId}&limit=1

Payment Endpoints

Get a Payment by Id (GET)

Used to read a payment with its latest charge and that charge's balance transaction, which carries Stripe's fee.

[Base URL]/v1/payment_intents/{Id}?expand[]=latest_charge.balance_transaction

List a Payment's Refunds (GET)

[Base URL]/v1/refunds?payment_intent={PaymentIntentId}&limit=100&expand[]=data.balance_transaction

List a Payment's Disputes (GET)

[Base URL]/v1/disputes?payment_intent={PaymentIntentId}&limit=100

Get a Charge, Refund or Dispute by Id (GET)

Used when a webhook or Manual Sync names a charge (ch_ or py_), refund (re_) or dispute (du_), to find the payment it belongs to.

[Base URL]/v1/charges/{Id}
[Base URL]/v1/refunds/{Id}
[Base URL]/v1/disputes/{Id}

Checkout Session Endpoints

Get a Checkout Session by Id (GET)

Used during TO iPaaS.com transfers to read a Payment Link sale.

[Base URL]/v1/checkout/sessions/{Id}

List a Checkout Session's Line Items (GET)

Used to read a Payment Link sale's lines, with each price's product.

[Base URL]/v1/checkout/sessions/{Id}/line_items?limit=100&starting_after={LineItemId}&expand[]=data.price.product

Find the Checkout Session of a Payment (GET)

[Base URL]/v1/checkout/sessions?payment_intent={PaymentIntentId}&limit=1

Price Endpoints

Get a Price by Id (GET)

Used to read a sale line's price with its product: the price's lookup key, or else the product's sku metadata, is matched to an iPaaS.com SKU.

[Base URL]/v1/prices/{Id}?expand[]=product

Customer Endpoints

Get a Customer by Id (GET)

[Base URL]/v1/customers/{Id}

List Customers by Email (GET)

Used to find the Stripe customer with an email; Stripe's list matches the exact email and shows a new customer at once.

[Base URL]/v1/customers?email={Email}&limit=20

Search Customers (GET)

Used to find the Stripe customer that carries an iPaaS.com customer id in its metadata.

[Base URL]/v1/customers/search?query=metadata['{Key}']:'{Value}'&limit=20

Create a Customer (POST)

Used when no Stripe customer matches. Each create carries an Idempotency-Key.

[Base URL]/v1/customers

Update a Customer (POST)

[Base URL]/v1/customers/{Id}

Event Endpoints

List Events (GET)

Used by the invoice.poll and customer.poll scheduled events to read the Stripe events created since the last run, at most 20 event types per call.

[Base URL]/v1/events?created[gt]={After}&created[lte]={Until}&types[]={EventType}&limit=100&starting_after={EventId}

Webhook Endpoint Endpoints

List Webhook Endpoints (GET)

Used to find this subscription's endpoint when a Stripe event is turned on or off under Inbound Data Flows.

[Base URL]/v1/webhook_endpoints?limit=100&starting_after={EndpointId}

Create a Webhook Endpoint (POST)

Used when the first Stripe event is turned on. The endpoint is described as iPaaS.com with the subscription's id, and uses the same API version as every other call.

[Base URL]/v1/webhook_endpoints

Update a Webhook Endpoint (POST)

Used to add or remove an event when one is turned on or off.

[Base URL]/v1/webhook_endpoints/{Id}

Delete a Webhook Endpoint (DELETE)

Used when the last Stripe event is turned off.

[Base URL]/v1/webhook_endpoints/{Id}

Authorization Endpoint

There is no separate authorization endpoint and no OAuth flow. Every call sends the Secret Key (a Stripe secret key or restricted key) as a bearer token in the Authorization header, with the Stripe-Version header set to the integration's API version (Stripe's guide: https://docs.stripe.com/keys). The connection check reads the account (see Account Endpoints) to prove the key. A restricted key needs the permissions listed in Stripe Connections and Settings.

Pagination

Stripe's list endpoints return a page of results with a has_more flag; the integration asks for up to 100 per page and passes the last id it read as starting_after to read the next page (https://docs.stripe.com/api/pagination). Search endpoints return up to the limit asked for, here 20.

Rate Limits and Concurrency

Stripe allows 100 requests per second in live mode and 25 in a sandbox, with 25 per second on most individual endpoints and 20 read requests per second on the Search API, which the invoice and customer searches use (https://docs.stripe.com/rate-limits, read 2026-11-18). When Stripe asks the integration to slow down, the transfer is rescheduled automatically (STRP-EXTN-1003). The subscription's Concurrent Connections, API Throttle Limit and API Throttle Seconds settings bound how many calls the integration makes at once; lower Concurrent Connections if the rate limit appears often (see Stripe Connections and Settings).

Related Documents

Did this answer your question?