File Coverage

lib/Net/API/Stripe/Billing/Invoice/Settings.pm
Criterion Covered Total %
statement 19 24 79.1
branch n/a
condition n/a
subroutine 7 12 58.3
pod 5 5 100.0
total 31 41 75.6


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Billing/Invoice/Settings.pm
3             ## Version v0.101.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2022/10/29
8             ##
9             ##----------------------------------------------------------------------------
10             BEGIN
11             {
12             use strict;
13 2     2   24599651 use warnings;
  2         16  
  2         63  
14 2     2   10 use parent qw( Net::API::Stripe::Generic );
  2         4  
  2         60  
15 2     2   11 use vars qw( $VERSION );
  2         3  
  2         11  
16 2     2   142 our( $VERSION ) = 'v0.101.0';
  2         4  
  2         114  
17 2     2   39 };
18              
19             use strict;
20 2     2   11 use warnings;
  2         3  
  2         39  
21 2     2   9  
  2         4  
  2         279  
22              
23 0     0 1    
24              
25 0     0 1    
26             { amount_tax_display => { type => "scalar" } }, @_ ) ); }
27 0     0 1    
28             1;
29 0     0 1    
30              
31 0     0 1   =encoding utf8
32              
33             =head1 NAME
34              
35             Net::API::Stripe::Billing::Invoice::Settings - A Stripe Invoice Setting Object
36              
37             =head1 SYNOPSIS
38              
39             my $settings = $customer->invoice_settings({
40             customer_fields => $custom_field_object,
41             default_payment_method => 'pm_fake123456789',
42             footer => 'Big Corp, Inc',
43             });
44              
45             =head1 VERSION
46              
47             v0.101.0
48              
49             =head1 DESCRIPTION
50              
51             This defines the invoice settings. It is instantiated from method B<invoice_settings> in L<Net::API::Stripe::Custome>
52              
53             It is used by L<Net::API::Stripe::Billing::Invoice>, L<Net::API::Stripe::Customer::TaxIds>, and L<Net::API::Stripe::Customer>
54              
55             =head1 CONSTRUCTOR
56              
57             =head2 new( %ARG )
58              
59             Creates a new L<Net::API::Stripe::Billing::Invoice::Settings> object.
60             It may also take an hash like arguments, that also are method of the same name.
61              
62             =head1 METHODS
63              
64             =head2 custom_fields array of hashes
65              
66             Default custom fields to be displayed on invoices for this customer. This is a L<Net::API::Stripe::CustomField> object
67              
68             =head2 days_until_due integer
69              
70             Number of days within which a customer must pay invoices generated by this quote. This value will be C<null> for quotes where C<collection_method=charge_automatically>.
71              
72             =head2 default_payment_method string (expandable)
73              
74             ID of the default payment method used for subscriptions and invoices for the customer.
75              
76             When expanded, this is a L<Net::API::Stripe::Payment::Method> object.
77              
78             =head2 footer string
79              
80             Default footer to be displayed on invoices for this customer.
81              
82             =head2 rendering_options hash
83              
84             Default options for invoice PDF rendering for this customer.
85              
86             It has the following properties:
87              
88             =over 4
89              
90             =item C<amount_tax_display> string
91              
92             How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
93              
94             =back
95              
96             =head1 API SAMPLE
97              
98             No sample data found yet
99              
100             =head1 HISTORY
101              
102             =head2 v0.1
103              
104             Initial version
105              
106             =head1 AUTHOR
107              
108             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
109              
110             =head1 SEE ALSO
111              
112             Stripe API documentation:
113              
114             L<https://stripe.com/docs/api/invoices/object>
115              
116             =head1 COPYRIGHT & LICENSE
117              
118             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
119              
120             You can use, copy, modify and redistribute this package and associated
121             files under the same terms as Perl itself.
122              
123             =cut