Stripe Retrieve
CertifiedFetch Stripe account balances
Stripe Retrieve
Fetch Stripe account balances
Calls Stripe to return available and pending balances per currency using the provided secret key. Live vs test data depends on the API key; response includes the raw Stripe JSON for auditing.
type: io.kestra.plugin.stripe.balance.RetrieveExamples
Get current balance
id: get_balance
namespace: company.team
tasks:
- id: get_balance
type: io.kestra.plugin.stripe.balance.Retrieve
apiKey: "{{ secret('STRIPE_API_KEY') }}"
Properties
apiKey *string
Stripe API Key
Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150Outputs
available array
Available balances
Amounts ready to payout, grouped by currency; values are in the smallest currency unit
pending array
Pending balances
Amounts not yet available, grouped by currency; values are in the smallest currency unit
raw object
Raw Stripe response
Full balance payload converted to a map for debugging or downstream use
