LatticeStripe.Subscription.TrialSettings (LatticeStripe v1.1.0)

Copy Markdown View Source

Represents the trial_settings nested object on a Stripe Subscription.

Currently exposes end_behavior as a plain map. The leaf field inside (missing_payment_method) is intentionally not promoted to a typed field — Stripe may add more end-behavior controls in future and end_behavior is documented as an open map.

Example:

%LatticeStripe.Subscription.TrialSettings{
  end_behavior: %{"missing_payment_method" => "cancel"}
}

See Stripe Subscription API.

Summary

Types

t()

Trial settings for a Stripe Subscription.

Functions

from_map(map)

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

Types

t()

@type t() :: %LatticeStripe.Subscription.TrialSettings{
  end_behavior: map() | nil,
  extra: map()
}

Trial settings for a Stripe Subscription.

Functions

from_map(map)

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

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

Returns nil when given nil.