File Coverage

lib/Net/API/Stripe/Billing/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

##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/Billing/TaxID.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <[e-mail]>
## Created 2019/12/19
## Modified 2020/05/15
##
##----------------------------------------------------------------------------
## https://stripe.com/docs/api/customer_tax_ids
package Net::API::Stripe::Billing::TaxID;
BEGIN
{
    use strict;
    use warnings;
    use parent qw( Net::API::Stripe::Generic );
    use vars qw( $VERSION );
    our( $VERSION ) = 'v0.100.0';
};

use strict;
use warnings;

sub id { return( shift->_set_get_scalar( 'id', @_ ) ); }

sub object { return( shift->_set_get_scalar( 'object', @_ ) ); }

sub country { return( shift->_set_get_scalar( 'country', @_ ) ); }

sub created { return( shift->_set_get_datetime( 'created', @_ ) ); }

sub customer { return( shift->_set_get_scalar_or_object( 'customer', 'Net::API::Stripe::Customer', @_ ) ); }

sub livemode { return( shift->_set_get_boolean( 'livemode', @_ ) ); }

sub type { return( shift->_set_get_scalar( 'type', @_ ) ); }

sub value { return( shift->_set_get_scalar( 'value', @_ ) ); }

sub verification { return( shift->_set_get_hash( 'verification', @_ ) ); }

1;

__END__

=encoding utf8

=head1 NAME

Net::API::Stripe::Billing::TaxID - A Stripe Customer Tax ID Object

=head1 SYNOPSIS

    my $tax = $stripe->tax_id({
        country => 'JP',
        customer => $customer_object,
        # or maybe 'unknown'
        type => 'eu_vat',
    });

=head1 VERSION

    v0.100.0

=head1 DESCRIPTION

You can add one or multiple tax IDs to a customer. A customer's tax IDs are displayed on invoices and credit notes issued for the customer.

See Customer Tax Identification Numbers L<https://stripe.com/docs/billing/taxes/tax-ids> for more information.

=head1 CONSTRUCTOR

=head2 new

Creates a new L<Net::API::Stripe::Billing::TaxID> object.
It may also take an hash like arguments, that also are method of the same name.

=head1 METHODS

=head2 id string

Unique identifier for the object.

=head2 object string, value is "tax_id"

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

=head2 country string

Two-letter ISO code representing the country of the tax ID.

=head2 created timestamp

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

=head2 customer string (expandable)

ID of the customer. When expanded, this is a L<Net::API::Stripe::Customer> object.

=head2 livemode boolean

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

=head2 type string

Type of the tax ID, one of au_abn, ch_vat, eu_vat, in_gst, mx_rfc, no_vat, nz_gst, za_vat, or unknown

=head2 value string

Value of the tax ID.

=head2 verification hash

Tax ID verification information.

=over 4

=item I<status> string

Verification status, one of pending, unavailable, unverified, or verified.

=item I<verified_address> string

Verified address

=item I<verified_name> string

Verified name.

=back

=head1 API SAMPLE

    {
      "id": "txi_123456789",
      "object": "tax_id",
      "country": "DE",
      "created": 123456789,
      "customer": "cus_fake123456789",
      "livemode": false,
      "type": "eu_vat",
      "value": "DE123456789",
      "verification": {
        "status": "pending",
        "verified_address": null,
        "verified_name": null
      }
    }

=head1 HISTORY

=head2 v0.1

Initial version

=head1 STRIPE HISTORY

=head2 2019-12-19

Initially introduced by Stripe in December 2019.

=head1 AUTHOR

Jacques Deguest E<lt>F<[e-mail]>E<gt>

=head1 SEE ALSO

Stripe API documentation:

L<https://stripe.com/docs/api/customer_tax_ids/object>, L<https://stripe.com/docs/billing/migration/taxes#moving-from-taxinfo-to-customer-tax-ids>,
L<https://stripe.com/docs/billing/taxes/tax-ids>

=head1 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.

=cut