NAME
Net::API::Stripe::Shipping - A Stripe Shipping Object
SYNOPSIS
my $shipping = $stripe->shipping({
address => $address_object,
carrier => 'DHL',
eta => '2020-04-12T08:00:00',
name => 'John Doe',
phone => '+81-(0)90-1234-5678',
service => 'express',
status => 'pending',
tracking_number => 1234567890,
tracking_url => 'https://track.example.com/1234567890',
type => 'individual',
});VERSION
v0.101.0DESCRIPTION
Where and how things will be shipped.
This is inherited by: Net::API::Stripe::Charge::Shipping, Net::API::Stripe::Customer::Shipping, Net::API::Stripe::Issuing::Card::Shipping, Net::API::Stripe::Order::Shipping, Net::API::Stripe::, Net::API::Stripe::
CONSTRUCTOR
new( %ARG )
Creates a new Net::API::Stripe::Shipping object. It may also take an hash like arguments, that also are method of the same name.
METHODS
address hash
Shipping address.
This is a Net::API::Stripe::Address object, if any.
carrier string
The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
customs hash
Additional information that may be required for clearing customs.
It has the following properties:
eori_numberstring-
A registration number used for customs in Europe. See https://www.gov.uk/eori and https://ec.europa.eu/taxationcustoms/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eorien.
eta timestamp
A unix timestamp representing a best estimate of when the card will be delivered.
name string
Recipient name.
phone string
Recipient phone (including extension).
phone_number string
The phone number of the receiver of the bulk shipment. This phone number will be provided to the shipping company, who might use it to contact the receiver in case of delivery issues.
service string
Shipment service, such as standard or express. Possible enum values
- standard
-
Cards arrive in 2-6 business days.
- express
-
Cards arrive in 2 business days.
- priority
-
Cards arrive in 1 business day.
status string
The delivery status of the card. One of pending, shipped, delivered, returned, failure, or canceled.
tracking_number string
A tracking number for a card shipment. This is a URI object.
tracking_url string
A link to the shipping carrier’s site where you can view detailed information about a card shipment.
This returns a URI object.
type string
One of bulk or individual. Bulk shipments will be grouped and mailed together, while individual ones will not.
API SAMPLE
{
"id": "ic_fake123456789",
"object": "issuing.card",
"authorization_controls": {
"allowed_categories": null,
"blocked_categories": null,
"currency": "usd",
"max_amount": 10000,
"max_approvals": 1,
"spending_limits": [],
"spending_limits_currency": null
},
"brand": "Visa",
"cardholder": {
"id": "ich_fake123456789",
"object": "issuing.cardholder",
"authorization_controls": {
"allowed_categories": [],
"blocked_categories": [],
"spending_limits": [],
"spending_limits_currency": null
},
"billing": {
"address": {
"city": "Beverly Hills",
"country": "US",
"line1": "123 Fake St",
"line2": "Apt 3",
"postal_code": "90210",
"state": "CA"
},
"name": "Jenny Rosen"
},
"company": null,
"created": 1540111055,
"email": "jenny@example.com",
"individual": null,
"is_default": false,
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"phone_number": "+18008675309",
"requirements": {
"disabled_reason": null,
"past_due": []
},
"status": "active",
"type": "individual"
},
"created": 1571652525,
"currency": "usd",
"exp_month": 8,
"exp_year": 2020,
"last4": "4242",
"livemode": false,
"metadata": {},
"name": "Jenny Rosen",
"pin": null,
"replacement_for": null,
"replacement_reason": null,
"shipping": null,
"status": "active",
"type": "physical"
}HISTORY
v0.100.0
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/issuing/cards/object
COPYRIGHT & LICENSE
Copyright (c) 2020-2020 DEGUEST Pte. Ltd.
You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.