File Coverage

lib/Net/API/Stripe/Customer/TaxInfo.pm

Criterion	Covered	Total	%
statement	19	21	90.4
branch			n/a
condition			n/a
subroutine	7	9	77.7
pod	2	2	100.0
total	28	32	87.5

##----------------------------------------------------------------------------
## Stripe API - ~/lib/Net/API/Stripe/Customer/TaxInfo.pm
## Version v0.100.0
## Copyright(c) 2019 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <[e-mail]>
## Created 2019/11/02
## Modified 2020/05/15
##
##----------------------------------------------------------------------------
package Net::API::Stripe::Customer::TaxInfo;
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 tax_id { return( shift->_set_get_scalar( 'tax_id', @_ ) ); }

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

1;

__END__


=encoding utf8

=head1 NAME

Net::API::Stripe::Customer::TaxInfo - A Stripe Customer Tax Info (deprecated)

=head1 SYNOPSIS

    my $tx_info = $stripe->customer->tax_info({
        tax_id => 'EU123456789',
        type => 'vat',
    });

=head1 VERSION

    v0.100.0

=head1 DESCRIPTION

The customer’s tax information. Appears on invoices emailed to this customer. This parameter has been deprecated and will be removed in a future API version, for further information view the migration guide (L<https://stripe.com/docs/billing/migration/taxes#moving-from-taxinfo-to-customer-tax-ids>).

This is instantiated by method B<tax_info> in module L<Net::API::Stripe::Customer>

=head1 CONSTRUCTOR

=head2 new( %ARG )

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

=head1 METHODS

=head2 tax_id required

The customer’s tax ID number.

=head2 type required

The type of ID number. The only possible value is vat

=head1 API SAMPLE

    {
      "id": "cus_fake123456789",
      "object": "customer",
      "address": null,
      "balance": 0,
      "created": 1572264551,
      "currency": "jpy",
      "default_source": null,
      "delinquent": false,
      "description": "Customer for [e-mail]",
      "discount": null,
      "email": null,
      "invoice_prefix": "BC0DE60",
      "invoice_settings": {
        "custom_fields": null,
        "default_payment_method": null,
        "footer": null
      },
      "livemode": false,
      "metadata": {},
      "name": null,
      "phone": null,
      "preferred_locales": [],
      "shipping": null,
      "sources": {
        "object": "list",
        "data": [],
        "has_more": false,
        "url": "/v1/customers/cus_fake123456789/sources"
      },
      "subscriptions": {
        "object": "list",
        "data": [],
        "has_more": false,
        "url": "/v1/customers/cus_fake123456789/subscriptions"
      },
      "tax_exempt": "none",
      "tax_ids": {
        "object": "list",
        "data": [],
        "has_more": false,
        "url": "/v1/customers/cus_fake123456789/tax_ids"
      },
      "tax_info": null,
      "tax_info_verification": null
    }

=head1 HISTORY

=head2 v0.1

Initial version

=head1 AUTHOR

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

=head1 SEE ALSO

Stripe API documentation:

L<https://stripe.com/docs/api/customers/create>, L<https://stripe.com/docs/billing/migration/taxes#moving-from-taxinfo-to-customer-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