Retrieve

Retrieve your Stripe account balance.

This task retrieves the current balance of your Stripe account.

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

Examples

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

apiKey *string

Stripe API Key

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

Outputs

available array

SubType object

List of available balances in different currencies

pending array

SubType object

List of pending balances in different currencies

raw object

The raw JSON response from Stripe as a Map

​Retrieve

Retrieve