stripity_stripe

v2.0.0-alpha.11

stripity_stripe v2.0.0-alpha.11 Stripe.Invoice

Work with Stripe invoice objects.

You can:

  • Create an invoice
  • Retrieve an invoice
  • Update an invoice

Does not take options yet.

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

Summary

Types

t()

Functions

create(changes, opts \\ [])

Create an invoice

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

List all invoices

retrieve(id, opts \\ [])

Retrieve an invoice

upcoming(changes, opts \\ [])

Retrieve an upcoming invoice

update(id, changes, opts \\ [])

Update an invoice

Types

t() 
t :: %Stripe.Invoice{amount_due: term, application_fee: term, attempt_count: term, attempted: term, charge: term, closed: term, currency: term, customer: term, date: term, description: term, discount: term, ending_balance: term, forgiven: term, id: term, lines: term, livemode: term, metadata: term, next_payment_attempt: term, object: term, paid: term, period_end: term, period_start: term, receipt_number: term, starting_balance: term, statement_descriptor: term, subscription: term, subscription_proration_date: term, subtotal: term, tax: term, tax_percent: term, total: term, webhooks_delivered_at: term}

Functions

create(changes, opts \\ []) 
create(map, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Create an invoice.

list(params \\ %{}, opts \\ []) 
list(map, Keyword.t) ::
  {:ok, Stripe.List.t} |
  {:error, Stripe.api_error_struct}

List all invoices.

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

Retrieve an invoice.

upcoming(changes, opts \\ []) 
upcoming(map, Keyword.t) ::
  {:ok, t} |
  {:error, Stripe.api_error_struct}

Retrieve an upcoming invoice.

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

Update an invoice.

Takes the id and a map of changes.