File Coverage

lib/Net/API/Stripe/Connect/ApplicationFee/Refund.pm
Criterion Covered Total %
statement 19 27 70.3
branch n/a
condition n/a
subroutine 7 15 46.6
pod 8 8 100.0
total 34 50 68.0


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Connect/ApplicationFee/Refund.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             ## https://stripe.com/docs/api/fee_refunds/object
11             BEGIN
12             {
13             use strict;
14 2     2   24300052 use warnings;
  2         18  
  2         63  
15 2     2   11 use parent qw( Net::API::Stripe::Generic );
  2         3  
  2         63  
16 2     2   9 use vars qw( $VERSION );
  2         4  
  2         10  
17 2     2   147 our( $VERSION ) = 'v0.100.0';
  2         5  
  2         127  
18 2     2   48 };
19              
20             use strict;
21 2     2   14 use warnings;
  2         5  
  2         39  
22 2     2   11  
  2         5  
  2         378  
23              
24 0     0 1    
25              
26 0     0 1    
27              
28 0     0 1    
29              
30 0     0 1    
31             1;
32 0     0 1    
33              
34 0     0 1   =encoding utf8
35              
36 0     0 1   =head1 NAME
37              
38 0     0 1   Net::API::Stripe::Connect::ApplicationFee::Refund - A Stripe Application Fee Refund Object
39              
40             =head1 SYNOPSIS
41              
42             my $refund = $stripe->application_fee->refund({
43             amount => 10000,
44             ## Net::API::Stripe::Balance::Transaction
45             balance_transaction => $balance_transaction_object,
46             currency => 'jpy',
47             fee => 290,
48             metadata => { cust_id => 123, trans_id => 456 },
49             });
50              
51             =head1 VERSION
52              
53             v0.100.0
54              
55             =head1 DESCRIPTION
56              
57             Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.
58              
59             =head1 CONSTRUCTOR
60              
61             =head2 new( %ARG )
62              
63             Creates a new L<Net::API::Stripe::Connect::ApplicationFee::Refund> object.
64             It may also take an hash like arguments, that also are method of the same name.
65              
66             =head1 METHODS
67              
68             =head2 id string
69              
70             Unique identifier for the object.
71              
72             =head2 object string, value is "fee_refund"
73              
74             String representing the object’s type. Objects of the same type share the same value.
75              
76             =head2 amount integer
77              
78             Amount, in JPY.
79              
80             =head2 balance_transaction string (expandable)
81              
82             Balance transaction that describes the impact on your account balance.
83              
84             =head2 created timestamp
85              
86             Time at which the object was created. Measured in seconds since the Unix epoch.
87              
88             This is a C<DateTime> object.
89              
90             =head2 currency currency
91              
92             Three-letter ISO currency code, in lowercase. Must be a supported currency.
93              
94             =head2 fee string (expandable)
95              
96             ID of the application fee that was refunded.
97              
98             =head2 metadata hash
99              
100             Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
101              
102             =head1 API SAMPLE
103              
104             {
105             "id": "fr_fake123456789",
106             "object": "fee_refund",
107             "amount": 100,
108             "balance_transaction": null,
109             "created": 1571480455,
110             "currency": "jpy",
111             "fee": "fee_fake123456789",
112             "metadata": {}
113             }
114              
115             =head1 HISTORY
116              
117             =head2 v0.1
118              
119             Initial version
120              
121             =head1 AUTHOR
122              
123             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
124              
125             =head1 SEE ALSO
126              
127             Stripe API documentation:
128              
129             L<https://stripe.com/docs/api/fee_refunds>, L<https://stripe.com/docs/connect/destination-charges#refunding-app-fee>
130              
131             =head1 COPYRIGHT & LICENSE
132              
133             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
134              
135             You can use, copy, modify and redistribute this package and associated
136             files under the same terms as Perl itself.
137              
138             =cut