NAME

Net::API::Stripe::Shipping::Rate - The shipping rate object

SYNOPSIS

VERSION

    v0.1.0

DESCRIPTION

Shipping rates describe the price of shipping presented to your customers and can be applied to Checkout Sessions to collect shipping costs.

METHODS

id string

Unique identifier for the object.

object string

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

active boolean

Whether the shipping rate can be used for new purchases. Defaults to true.

created timestamp

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

delivery_estimate hash

The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

It has the following properties:

maximum hash

The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

unit string

A unit of time.

value integer

Must be greater than 0.

minimum hash

The lower bound of the estimated range. If empty, represents no lower bound.

unit string

A unit of time.

value integer

Must be greater than 0.

display_name string

The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

fixed_amount object

Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

This is a Net::API::Stripe::Balance::ConnectReserved 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.

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.

tax_behavior string

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

tax_code expandable

A tax code ID. The Shipping tax code is txcd_92010001.

When expanded this is an Net::API::Stripe::Product::TaxCode object.

type string

The type of calculation to use on the shipping rate. Can only be fixed_amount for now.

API SAMPLE

    {
      "id": "shr_1KJGon2eZvKYlo2C3Hc5P110",
      "object": "shipping_rate",
      "active": true,
      "created": 1642508985,
      "delivery_estimate": null,
      "display_name": "Ground shipping",
      "fixed_amount": {
        "amount": 500,
        "currency": "usd"
      },
      "livemode": false,
      "metadata": {
      },
      "tax_behavior": "unspecified",
      "tax_code": null,
      "type": "fixed_amount"
    }

HISTORY

v0.1.0

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation

COPYRIGHT & LICENSE

Copyright (c) 2019-2022 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