NAME

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

SYNOPSIS

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

VERSION

v0.100.0

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 https://stripe.com/docs/billing/taxes/tax-ids for more information.

CONSTRUCTOR

new

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

METHODS

id string

Unique identifier for the object.

object string, value is "tax_id"

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

country string

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

created timestamp

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

customer string (expandable)

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

livemode boolean

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

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

value string

Value of the tax ID.

verification hash

Tax ID verification information.

status string

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

verified_address string

Verified address

verified_name string

Verified name.

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
  }
}

HISTORY

v0.1

Initial version

STRIPE HISTORY

2019-12-19

Initially introduced by Stripe in December 2019.

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

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

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.