/ 
Net-API-Stripe-v2.0.6
River stage one • 1 direct dependent • 1 total dependent
/ Net::API::Stripe::File::Link

NAME

Net::API::Stripe::File::Link - A Stripe File Link Object

SYNOPSIS

my $link = $stripe->file_link({
    expires_at => '2020-04-12',
    file => $file_object,
    livemode => $stripe->false,
    metadata => { transaction_id => 123 },
    url => 'https://example.com/some/file.jpg',
});

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 a Stripe File Link object.

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that can be used to retrieve the contents of the file without authentication.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::File::Link 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_link"

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.

expired boolean

Whether this link is already expired.

expires_at timestamp

Time at which the link expires.

file string (expandable)

The file object this link points to.

When expanded, this is a Net::API::Stripe::File 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.

url string

The publicly accessible URL to download the file.

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/object, https://stripe.com/docs/api/file_links/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.