NAME

Net::API::Stripe::Balance - The Balance object

SYNOPSIS

        my $object = $stripe->balances( 'retrieve' ) || die( $stripe->error );

VERSION

    0.1

DESCRIPTION

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

You can also retrieve the balance history, which contains a list of transactions (https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance (charges, payouts, and so forth).

The available and pending amounts for each currency are broken down further by payment source types.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Balance object.

METHODS

object string, value is "balance"

String representing the object’s type. Objects of the same type share the same value.

available array of Net::API::Stripe::Connect::Transfer

Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the Transfers API or Payouts API. The available balance for each currency and payment type can be found in the source_types property.

Currently this is an array of Net::API::Stripe::Connect::Transfer, but I am considering revising that in light of the documentation of the Stripe API.

amount integer

Balance amount.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

source_types hash

Breakdown of balance by source types.

bank_account integer

Amount for bank account.

card integer

Amount for card.

connect_reserved array of Net::API::Stripe::Balance::ConnectReserved objects.

Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the source_types property.

amount integer

Balance amount.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

source_types hash

Breakdown of balance by source types.

livemode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

pending array of Net::API::Stripe::Balance::Pending objects.

Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the source_types property.

amount integer

Balance amount.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

source_types hash

Breakdown of balance by source types.

API SAMPLE

        {
          "object": "balance",
          "available": [
                {
                  "amount": 0,
                  "currency": "jpy",
                  "source_types": {
                        "card": 0
                  }
                }
          ],
          "connect_reserved": [
                {
                  "amount": 0,
                  "currency": "jpy"
                }
          ],
          "livemode": false,
          "pending": [
                {
                  "amount": 7712,
                  "currency": "jpy",
                  "source_types": {
                        "card": 7712
                  }
                }
          ]
        }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

https://stripe.com/docs/api/balance, https://stripe.com/docs/connect/account-balances

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.