stripity_stripe

stripity_stripe v2.7.0 Stripe.FileUpload View Source

Work with Stripe file_upload objects.

You can:

  • Create a file
  • Retrieve a file
  • List all files

Stripe API reference: https://stripe.com/docs/api/files

Link to this section Summary

Types

t()

Functions

create(params, opts \\ [])

Create a file according to Stripe's file_upload rules.

list(params \\ %{}, opts \\ [])

List all file uploads, going back up to 30 days.

retrieve(id, opts \\ [])

Retrieve a file_upload.

Link to this section Types

Link to this type

t() View Source 
t() :: %Stripe.FileUpload{
  created: Stripe.timestamp(),
  filename: String.t() | nil,
  id: Stripe.id(),
  object: String.t(),
  purpose: String.t(),
  size: integer(),
  type: String.t() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

create(params, opts \\ []) View Source 
create(map(), Keyword.t()) :: {:ok, t()} | {:error, Stripe.Error.t()}

Create a file according to Stripe's file_upload rules.

Takes the filepath and the purpose.

Link to this function

list(params \\ %{}, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:purpose) => String.t(),
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all file uploads, going back up to 30 days.

Link to this function

retrieve(id, opts \\ []) View Source 
retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a file_upload.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog