LatticeStripe.Product.Feature (LatticeStripe v2.2.0)

Stripe Product Feature attachments.

A %Feature{} is the product_feature attachment (an id prefixed prodft_) between a Product (prod_) and an LatticeStripe.Entitlements.Feature definition (feat_). It is not the Product's features or marketing_features display copy.

Use the canonical create/4, retrieve/4, list/4, stream!/4, and delete/4 resource verbs in code. In domain prose, an attachment is something you attach to or remove from a Product; this module intentionally publishes no parallel attach, detach, or remove aliases. list/4 and stream!/4 are the authoritative catalog reads for access-bearing attachments.

See LatticeStripe.Entitlements.Feature for the definition side of the relationship, and Entitlements for the catalog-to-access lifecycle.

Summary

Types

t()

Functions

create(client, product_id, params, opts \\ [])

Attach an entitlement feature definition to a Product.

create!(client, product_id, params, opts \\ [])

Bang variant of create/4. Raises LatticeStripe.Error on failure.

delete(client, product_id, product_feature_id, opts \\ [])

Delete one Product Feature attachment by its prodft_ id.

delete!(client, product_id, product_feature_id, opts \\ [])

Bang variant of delete/4. Raises LatticeStripe.Error on failure.

from_map(feature)

Decode a Stripe Product Feature attachment map.

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

List Product Feature attachments for a Product.

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

Bang variant of list/4. Raises LatticeStripe.Error on failure.

retrieve(client, product_id, product_feature_id, opts \\ [])

Retrieve one Product Feature attachment by its prodft_ id.

retrieve!(client, product_id, product_feature_id, opts \\ [])

Bang variant of retrieve/4. Raises LatticeStripe.Error on failure.

stream!(client, product_id, params \\ %{}, opts \\ [])

Lazily enumerate every Product Feature attachment for a Product.

Types

t()

@type t() :: %LatticeStripe.Product.Feature{
  deleted: boolean(),
  entitlement_feature: LatticeStripe.Entitlements.Feature.t() | nil,
  extra: map(),
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: String.t() | nil
}

Functions

create(client, product_id, params, opts \\ [])

@spec create(LatticeStripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Attach an entitlement feature definition to a Product.

params must contain the string key "entitlement_feature"; it has no default because Stripe's attachment endpoint requires that definition ID.

create!(client, product_id, params, opts \\ [])

@spec create!(LatticeStripe.Client.t(), String.t(), map(), keyword()) :: t()

Bang variant of create/4. Raises LatticeStripe.Error on failure.

delete(client, product_id, product_feature_id, opts \\ [])

@spec delete(LatticeStripe.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Delete one Product Feature attachment by its prodft_ id.

delete!(client, product_id, product_feature_id, opts \\ [])

@spec delete!(LatticeStripe.Client.t(), String.t(), String.t(), keyword()) :: t()

Bang variant of delete/4. Raises LatticeStripe.Error on failure.

from_map(feature)

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

Decode a Stripe Product Feature attachment map.

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

@spec list(LatticeStripe.Client.t(), String.t(), map(), keyword()) ::
  {:ok, LatticeStripe.Response.t()} | {:error, LatticeStripe.Error.t()}

List Product Feature attachments for a Product.

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

@spec list!(LatticeStripe.Client.t(), String.t(), map(), keyword()) ::
  LatticeStripe.Response.t()

Bang variant of list/4. Raises LatticeStripe.Error on failure.

retrieve(client, product_id, product_feature_id, opts \\ [])

@spec retrieve(LatticeStripe.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, t()} | {:error, LatticeStripe.Error.t()}

Retrieve one Product Feature attachment by its prodft_ id.

retrieve!(client, product_id, product_feature_id, opts \\ [])

@spec retrieve!(LatticeStripe.Client.t(), String.t(), String.t(), keyword()) :: t()

Bang variant of retrieve/4. Raises LatticeStripe.Error on failure.

stream!(client, product_id, params \\ %{}, opts \\ [])

@spec stream!(LatticeStripe.Client.t(), String.t(), map(), keyword()) ::
  Enumerable.t()

Lazily enumerate every Product Feature attachment for a Product.

Pagination mechanics are delegated to LatticeStripe.List.stream!/2; each attachment is decoded as it is emitted. There is intentionally no non-bang stream variant because later-page failures raise while a stream is consumed.