NAME

Net::API::Stripe::Order::ShippingMethod - A Stripe Order Shipping Method Object

SYNOPSIS

    my $meth = $stripe->order->shipping_method({
        id => 'SP2020041201',
        amount => 2000,
        currency => 'jpy',
        delivery_estimate => $estimate_object,
        description => 'Easter present',
    });

VERSION

    v0.100.0

DESCRIPTION

A list of supported shipping methods for this order. The desired shipping method can be specified either by updating the order, or when paying it.

This is instantiated by method shipping_methods in module Net::API::Stripe::Order

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Order::ShippingMethod 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.

amount integer

A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the line item.

currency currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

delivery_estimate hash

The estimated delivery date for the given shipping method. Can be either a specific date or a range.

This is a Net::API::Stripe::Order::DeliveryEstimate object.

API SAMPLE

        {
          "id": "or_fake123456789",
          "object": "order",
          "amount": 1500,
          "amount_returned": null,
          "application": null,
          "application_fee": null,
          "charge": null,
          "created": 1571480453,
          "currency": "jpy",
          "customer": null,
          "email": null,
          "items": [
                {
                  "object": "order_item",
                  "amount": 1500,
                  "currency": "jpy",
                  "description": "T-shirt",
                  "parent": "sk_fake123456789",
                  "quantity": null,
                  "type": "sku"
                }
          ],
          "livemode": false,
          "metadata": {},
          "returns": {
                "object": "list",
                "data": [],
                "has_more": false,
                "url": "/v1/order_returns?order=or_fake123456789"
          },
          "selected_shipping_method": null,
          "shipping": {
                "address": {
                  "city": "Anytown",
                  "country": "US",
                  "line1": "1234 Main street",
                  "line2": null,
                  "postal_code": "123456",
                  "state": null
                },
                "carrier": null,
                "name": "Jenny Rosen",
                "phone": null,
                "tracking_number": null
          },
          "shipping_methods": null,
          "status": "created",
          "status_transitions": {
                "canceled": null,
                "fulfiled": null,
                "paid": null,
                "returned": null
          },
          "updated": 1571480453
        }

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/orders/object

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.