Accrue.Billing.SubscriptionItems (accrue v1.0.0)

Copy Markdown View Source

Multi-item subscription surface.

add_item/3, remove_item/2, and update_item_quantity/3 mutate a subscription's item list through the processor adapter and project the result to the local accrue_subscription_items table inside a single Repo.transact/1 block.

All three require an explicit :proration option — Accrue never inherits Stripe's default proration behavior. Missing proration raises at NimbleOptions validation time.

The non-bang + reduce_while pattern is used for any list upsert path so Ecto.InvalidChangesetError propagates cleanly rather than aborting the enclosing transaction.

Summary

Functions

add_item(sub, price_id, opts \\ [])
add_item!(sub, price_id, opts \\ [])
remove_item(item, opts \\ [])
remove_item!(item, opts \\ [])
update_item_quantity(item, new_quantity, opts \\ [])
update_item_quantity!(item, qty, opts \\ [])

Functions

add_item(sub, price_id, opts \\ [])

@spec add_item(Accrue.Billing.Subscription.t(), String.t(), keyword()) ::
  {:ok, Accrue.Billing.SubscriptionItem.t()} | {:error, term()}

add_item!(sub, price_id, opts \\ [])

@spec add_item!(Accrue.Billing.Subscription.t(), String.t(), keyword()) ::
  Accrue.Billing.SubscriptionItem.t()

remove_item(item, opts \\ [])

@spec remove_item(
  Accrue.Billing.SubscriptionItem.t(),
  keyword()
) :: {:ok, Accrue.Billing.SubscriptionItem.t()} | {:error, term()}

remove_item!(item, opts \\ [])

@spec remove_item!(
  Accrue.Billing.SubscriptionItem.t(),
  keyword()
) :: Accrue.Billing.SubscriptionItem.t()

update_item_quantity(item, new_quantity, opts \\ [])

@spec update_item_quantity(
  Accrue.Billing.SubscriptionItem.t(),
  pos_integer(),
  keyword()
) ::
  {:ok, Accrue.Billing.SubscriptionItem.t()} | {:error, term()}

update_item_quantity!(item, qty, opts \\ [])

@spec update_item_quantity!(
  Accrue.Billing.SubscriptionItem.t(),
  pos_integer(),
  keyword()
) ::
  Accrue.Billing.SubscriptionItem.t()