NAME
Net::API::Stripe::File - A file in Stripe API
SYNOPSIS
my $file = $stripe->file({
filename => 'some_file.jpg',
links => $file_links_object,
purpose => 'business_logo',
size => 40069,
title => 'Big Corp, Inc Logo',
type => 'jpg',
url => 'https://files.stripe.com/v1/files/file_fake123456789/contents',
});
See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.
VERSION
v0.100.0
DESCRIPTION
This is an object representing a file hosted on Stripe's servers. The file may have been uploaded by yourself using the create file request (for example, when uploading dispute evidence) or it may have been created by Stripe (for example, the results of a Sigma scheduled query https://stripe.com/docs/api/files#scheduled_queries).
CONSTRUCTOR
- new( %ARG )
-
Creates a new Net::API::Stripe::File 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 "file"
-
String representing the object’s type. Objects of the same type share the same value.
- created timestamp
-
Time at which the object was created. Measured in seconds since the Unix epoch.
- filename string
-
A filename for the file, suitable for saving to a filesystem.
- links list
-
This is a Net::API::Stripe::File::Links object.
- purpose string
-
The purpose of the file. Possible values are business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document, pci_document, sigma_scheduled_query, or tax_document_user_upload.
- size integer
-
The size in bytes of the file object.
- title string
-
A user friendly title for the document.
- type string
-
The type of the file returned (e.g., csv, pdf, jpg, or png).
- url string
-
The URL from which the file can be downloaded using your live secret API key.
API SAMPLE
{
"id": "file_fake123456789",
"object": "file",
"created": 1540111053,
"filename": "file_fake123456789",
"links": {
"object": "list",
"data": [
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571229407,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571225071,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571223490,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_1FUA14CeyNCl6fY2s3gFUjmP",
"object": "file_link",
"created": 1571222766,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571197169,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571176460,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1571099998,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1551509650,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1551509211,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
},
{
"id": "link_fake123456789",
"object": "file_link",
"created": 1547559540,
"expired": false,
"expires_at": null,
"file": "file_fake123456789",
"livemode": false,
"metadata": {},
"url": "https://files.stripe.com/links/fl_test_fake123456789"
}
],
"has_more": true,
"url": "/v1/file_links?file=file_fake123456789"
},
"purpose": "dispute_evidence",
"size": 9863,
"title": null,
"type": "png",
"url": "https://files.stripe.com/v1/files/file_fake123456789/contents"
}
HISTORY
v0.1
Initial version
AUTHOR
Jacques Deguest <jack@deguest.jp>
SEE ALSO
Stripe API documentation:
https://stripe.com/docs/api/files, https://stripe.com/docs/file-upload
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.