NAME

Net::API::Stripe::Tax::Rate - A Stripe Tax Rate Object

SYNOPSIS

    my $rate = $stripe->tax_rate({
        active => $stripe->true,
        created => '2020-04-12T17:12:10',
        description => 'Japan VAT applicable to customers',
        display_name => 'Japan VAT',
        inclusive => $stripe->false,
        jurisdiction => 'jp',
        livemode => $stripe->false,
        metadata => { tax_id => 123, customer_id => 456 },
        percentage => 10,
    });

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

    v0.102.0

DESCRIPTION

This is used in Net::API::Stripe::Billing::Invoice to describe a list of tax rates, and also in Net::API::Stripe::Billing::Subscription::Schedule in phases->default_tax_rates.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Tax::Rate 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_rate"

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

active boolean

Defaults to true. When set to false, this tax rate cannot be applied to objects in the API, but will still be applied to subscriptions and invoices that already have it set.

country string

Two-letter country code (ISO 3166-1 alpha-2.

created timestamp

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

description string

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

display_name string

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

inclusive boolean

This specifies if the tax rate is inclusive or exclusive.

jurisdiction string

The jurisdiction for the tax rate.

livemode boolean

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

metadata hash

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

percentage decimal

This represents the tax rate percent out of 100.

state string

ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.

tax_type string

The high-level tax type, such as vat or sales_tax.

API SAMPLE

    {
      "id": "txr_1GWkAHCeyNCl6fY2QtB0BbzC",
      "object": "tax_rate",
      "active": true,
      "created": 1586614713,
      "description": "VAT Germany",
      "display_name": "VAT",
      "inclusive": false,
      "jurisdiction": "DE",
      "livemode": false,
      "metadata": {},
      "percentage": 19.0
    }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/tax_rates

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.

cpanm Net::API::Stripe

perl -MCPAN -e shell
install Net::API::Stripe