NAME

Net::API::Stripe::Connect::ApplicationFee - A Stripe Application Fee Object

SYNOPSIS

    my $app_fee = $stripe->application_fee({
        account => $account_object,
        amount => 2000,
        balance_transaction => $balance_transaction_object,
        currency => 'jpy',
    });

VERSION

    0.1

DESCRIPTION

When you collect a transaction fee on top of a charge made for your user (using Connect https://stripe.com/docs/connect), an Application Fee object is created in your account. You can list, retrieve, and refund application fees.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Connect::ApplicationFee object. It may also take an hash like arguments, that also are method of the same name.

METHODS

id string

Unique identifier for the object.

object string, value is "application_fee"

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

account string (expandable)

ID of the Stripe account this fee was taken from. When expanded, this is a Net::API::Stripe::Connect::Account object.

amount integer

Amount earned, in JPY.

amount_refunded positive integer or zero

Amount in JPY refunded (can be less than the amount attribute on the fee if a partial refund was issued)

application string (expandable) "application"

ID of the Connect application that earned the fee. When expanded, this is a Net::API::Stripe::Connect::Account object.

balance_transaction string (expandable)

Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).

When expanded, this is a Net::API::Stripe::Balance::Transaction object.

charge string (expandable)

ID of the charge that the application fee was taken from. When expanded, this is a Net::API::Stripe::Charge object.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

This is a DateTime object.

currency currency

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

livemode boolean

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

originating_transaction string (expandable) charge or transfer

ID of the corresponding charge on the platform account, if this fee was the result of a charge using the destination parameter.

When expanded, this is a Net::API::Stripe::Charge object.

refunded boolean

Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.

refunds list

A list of refunds that have been applied to the fee.

This is a Net::API::Stripe::Connect::ApplicationFee::Refunds object.

API SAMPLE

        {
          "id": "fee_fake123456789",
          "object": "application_fee",
          "account": "acct_fake123456789",
          "amount": 100,
          "amount_refunded": 0,
          "application": "ca_fake123456789",
          "balance_transaction": "txn_fake123456789",
          "charge": "ch_fake123456789",
          "created": 1571480455,
          "currency": "jpy",
          "livemode": false,
          "originating_transaction": null,
          "refunded": false,
          "refunds": {
                "object": "list",
                "data": [],
                "has_more": false,
                "url": "/v1/application_fees/fee_fake123456789/refunds"
          }
        }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/application_fees, https://stripe.com/docs/connect/direct-charges#collecting-fees

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.