Stripe Retrieve

Stripe Retrieve

Certified

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.

yaml
type: io.kestra.plugin.stripe.balance.Retrieve

Get current balance

yaml
id: get_balance
namespace: company.team

tasks:
  - id: get_balance
    type: io.kestra.plugin.stripe.balance.Retrieve
    apiKey: "{{ secret('STRIPE_API_KEY') }}"
Properties

Stripe API Key

Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.

Reference (ref) of the pluginDefaults to apply to this task.

SubTypeobject

Available balances

Amounts ready to payout, grouped by currency; values are in the smallest currency unit

SubTypeobject

Pending balances

Amounts not yet available, grouped by currency; values are in the smallest currency unit

Raw Stripe response

Full balance payload converted to a map for debugging or downstream use