stripity_stripe v2.0.0-alpha.6 Stripe.FileUpload

Work with Stripe file_upload objects.

You can:

  • Create a file
  • Retrieve a file

Stripe API reference: https://stripe.com/docs/api#file_uploads

Summary

Functions

Create a file according to Stripe’s file_upload rules

Retrieve a file_upload

Types

t()
t :: %Stripe.FileUpload{created: term, id: term, metadata: term, object: term, purpose: term, size: term, type: term}

Functions

create(filepath, purpose, opts \\ [])
create(Path.t, String.t, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Create a file according to Stripe’s file_upload rules.

Takes the filepath and the purpose.

retrieve(id, opts \\ [])
retrieve(binary, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Retrieve a file_upload.