StripeManaged.Invoice (StripeManaged v0.1.0)

Copy Markdown View Source

Retrieve invoices generated by Managed Payments subscriptions.

Invoices include the hosted_invoice_url field which gives customers access to a Stripe-hosted invoice page.

Note: One-off invoices cannot be created on Managed Payments subscriptions outside of billing periods.

Summary

Functions

Lists invoices. Filter by customer, subscription, status, etc.

Returns a lazy Stream of all invoices, auto-paginating.

Retrieves an invoice by ID.

Retrieves the upcoming invoice for a subscription.

Functions

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

@spec list(
  map(),
  keyword()
) :: StripeManaged.Client.response()

Lists invoices. Filter by customer, subscription, status, etc.

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

@spec list_all(
  map(),
  keyword()
) :: Enumerable.t()

Returns a lazy Stream of all invoices, auto-paginating.

retrieve(id, opts \\ [])

@spec retrieve(
  String.t(),
  keyword()
) :: StripeManaged.Client.response()

Retrieves an invoice by ID.

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

@spec upcoming(
  map(),
  keyword()
) :: StripeManaged.Client.response()

Retrieves the upcoming invoice for a subscription.