View as Markdown
Stripe icon

Stripe ACTION

List Balance History

List all balance transactions. By default returns an array of transaction objects (auto-paginated up to Limit). Set Return Pagination Info to true to instead receive { data, has_more, next_starting_after } for a single Stripe page (max 100 per call) — pass next_starting_after as Starting After on the next call to iterate. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stripe account once, then configure and run List Balance History from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "stripe-list-balance-history",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stripe: { authProvisionId: "apn_xxxxxxx" },
    payout: "Payout ID",
    currency: "Currency",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Balance History inputs
Property Type Description
payout Payout ID string
Example: po_0JL8pIGHO3mdGsgAthGqEt0m
Optional Dynamic
currency Currency string
Three-letter ISO currency code, in lowercase; must be a supported currency
Optional Dynamic
type Transaction Type string
The type of transaction to return. If not specified, all transactions will be returned.
Optional
limit Result Limit integer
Maximum records to return. Auto-paginated up to 10000 by default; capped at 100 when Return Pagination Info is enabled (Stripe's per-call limit).
Required
createdGt Created (Greater Than) string
Only return transactions that were created after this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z
Optional
createdGte Created (Greater Than Or Equal To) string
Only return transactions that were created after this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z
Optional
createdLt Created (Less Than) string
Only return transactions that were created before this date (exclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z
Optional
createdLte Created (Less Than Or Equal To) string
Only return transactions that were created before this date (inclusive). In ISO 8601 format. Eg. 2023-01-01T00:00:00Z
Optional
endingBefore Ending Before string
A cursor for use in pagination. Ending Before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
Optional
startingAfter Starting After string
A cursor for use in pagination. Starting After is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
Optional
returnPaginationInfo Return Pagination Info boolean
If true, returns { data, has_more, next_starting_after } instead of a plain array. Use this to paginate: pass the returned next_starting_after value as Starting After on the next call to fetch the next page. Default false returns an auto-paginated array.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
stripe-list-balance-history
Version
0.2.1
App
Stripe
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes