File Coverage

lib/Net/API/Stripe/Customer/TaxId.pm
Criterion Covered Total %
statement 19 28 67.8
branch n/a
condition n/a
subroutine 7 16 43.7
pod 9 9 100.0
total 35 53 66.0


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Customer/TaxId.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             BEGIN
11             {
12             use strict;
13 2     2   24103519 use warnings;
  2         13  
  2         61  
14 2     2   10 use parent qw( Net::API::Stripe::Generic );
  2         5  
  2         61  
15 2     2   9 use vars qw( $VERSION );
  2         7  
  2         11  
16 2     2   138 our( $VERSION ) = 'v0.100.0';
  2         5  
  2         108  
17 2     2   36 };
18              
19             use strict;
20 2     2   11 use warnings;
  2         4  
  2         36  
21 2     2   8  
  2         4  
  2         396  
22              
23 0     0 1    
24              
25 0     0 1    
26             ## Customer id
27 0     0 1    
28              
29 0     0 1   ## au_abn, ch_vat, eu_vat, in_gst, no_vat, nz_gst, unknown, or za_vat
30              
31              
32 0     0 1   # sub verification { return( shift->_set_get_object( 'verification', 'Net::API::Stripe::Customer::TaxInfoVerification', @_ ) ); }
33              
34 0     0 1   1;
35              
36              
37 0     0 1   =encoding utf8
38              
39 0     0 1   =head1 NAME
40              
41             Net::API::Stripe::Customer::TaxId - A Customer Tax ID object
42 0     0 1    
43             =head1 SYNOPSIS
44              
45             my $tax_id = $stripe->tax_id({
46             country => 'jp',
47             customer => $customer_object,
48             type => 'eu_vat',
49             value => 'EU123456789',
50             });
51              
52             See documentation in L<Net::API::Stripe> for example to make api calls to Stripe to create those objects.
53              
54             =head1 VERSION
55              
56             v0.100.0
57              
58             =head1 DESCRIPTION
59              
60             You can add one or multiple tax IDs to a customer (L<Net::API::Stripe::Customer> / L<https://stripe.com/docs/api/customers>). A customer's tax IDs are displayed on invoices and credit notes issued for the customer.
61              
62             =head1 CONSTRUCTOR
63              
64             =head2 new( %ARG )
65              
66             Creates a new L<Net::API::Stripe::Customer::TaxId> object.
67             It may also take an hash like arguments, that also are method of the same name.
68              
69             =head1 METHODS
70              
71             =head2 id string
72              
73             Unique identifier for the object.
74              
75             =head2 object string, value is "tax_id"
76              
77             String representing the object’s type. Objects of the same type share the same value.
78              
79             =head2 country string
80              
81             Two-letter ISO code representing the country of the tax ID.
82              
83             =head2 created timestamp
84              
85             Time at which the object was created. Measured in seconds since the Unix epoch.
86              
87             =head2 customer string (expandable)
88              
89             ID of the customer. When expanded, this is a L<Net::API::Stripe::Customer> object.
90              
91             =head2 livemode boolean
92              
93             Has the value true if the object exists in live mode or the value false if the object exists in test mode.
94              
95             =head2 type string
96              
97             Type of the tax ID, one of au_abn, ch_vat, eu_vat, in_gst, no_vat, nz_gst, unknown, or za_vat
98              
99             =head2 value string
100              
101             Value of the tax ID.
102              
103             =head2 verification object
104              
105             Tax ID verification information. This is a L<Net::API::Stripe::Customer::TaxInfoVerification> object.
106              
107             =head1 API SAMPLE
108              
109             {
110             "id": "txi_fake123456789",
111             "object": "tax_id",
112             "country": "DE",
113             "created": 123456789,
114             "customer": "cus_fake123456789",
115             "livemode": false,
116             "type": "eu_vat",
117             "value": "DE123456789",
118             "verification": {
119             "status": "pending",
120             "verified_address": null,
121             "verified_name": null
122             }
123             }
124              
125             =head1 HISTORY
126              
127             =head2 v0.1
128              
129             Initial version
130              
131             =head1 AUTHOR
132              
133             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
134              
135             =head1 SEE ALSO
136              
137             Stripe API documentation:
138              
139             L<https://stripe.com/docs/api/customer_tax_ids>, L<https://stripe.com/docs/billing/taxes/tax-ids>, L<https://en.wikipedia.org/wiki/VAT_identification_number>
140              
141             =head1 COPYRIGHT & LICENSE
142              
143             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
144              
145             You can use, copy, modify and redistribute this package and associated
146             files under the same terms as Perl itself.
147              
148             =cut