LatticeStripe.InvoiceItem.Period (LatticeStripe v1.7.2)

Copy Markdown View Source

Billing period for an InvoiceItem.

Summary

Types

t()

Billing period for a Stripe InvoiceItem.

Functions

from_map(map)

Converts a decoded Stripe API map to a %Period{} struct.

Types

t()

@type t() :: %LatticeStripe.InvoiceItem.Period{
  end: integer() | nil,
  start: integer() | nil
}

Billing period for a Stripe InvoiceItem.

Functions

from_map(map)

@spec from_map(map() | nil) :: t() | nil

Converts a decoded Stripe API map to a %Period{} struct.

Returns nil when given nil (InvoiceItem has no period field).

Example

iex> LatticeStripe.InvoiceItem.Period.from_map(%{"start" => 1_700_000_000, "end" => 1_702_000_000})
%LatticeStripe.InvoiceItem.Period{start: 1_700_000_000, end: 1_702_000_000}