Returns whether the provided subscription is active, which is if it has not ended, and it has a valid status.

Adds prices to an existing subscription. Returns the subscription with the items loaded.

examples

Examples

add_prices(subscription, prices: [{price_id, quantity}])

Fetches the stripe subscription object from a database subscription.

Cancels the subscription in stripe and updates the model. Cancellation is scheduled for the end of the period.

If the user is on a trial, they will have until the end of their trial.

examples

Examples

subscription = cancel(subscription)

# can pass any valid Stripe.Subscription.update/2 params
subscription = cancel(subscription, stripe: %{ prorate: false })

Cancels a subscription at a specific time.

examples

Examples

subscription = cancel_at(subscription, DateTime.utc_now() |> DateTime.add(30, :day))

# can pass any valid Stripe.Subscription.update/2 params
subscription = cancel_at(subscription, DateTime.utc_now() |> DateTime.add(30, :day), stripe: %{ prorate: false })

Cancels and ends the subscription immediately.

examples

Examples

subscription = cancel_now(subscription)

# can pass any valid Stripe.Subscription.delete/2 params
subscription = cancel_now(subscription, stripe: %{ invoice_now: true })

Cancels, ends, and invoices for the subscription immediately. Forwards any stripe options to Bling.Subscriptions.cancel_now/2.

Returns whether the provided subscription has been cancelled.

Changes the subscription to new prices.

examples

Examples

change_prices(sub, prices: [{price_id, quantity}])

Decrements the quantity of a subscription item. Defaults to decrementing the first item. Defaults to decrementing by one. Raises if trying to go below 0.

## Examples

  # this would update the first subscription item's quantity by one
  # useful for single price subscriptions
  subscription = decrement(subscription)

  # you can also specify a price and quantity to decrement by
  subscription = decrement(subscription, price_id: "price_123", quantity: 2)

  # can pass any valid Stripe.SubscriptionItem.update/2 params
  subscription = decrement(subscription, stripe: %{ prorate: false })

Deletes the subscription from the database as well as cancels it in stripe.

examples

Examples

subscription = delete(subscription)

# can pass any valid Stripe.Subscription.delete/2 params
subscription = delete(subscription, stripe: %{ invoice_now: true })

Returns whether the provided subscription has been cancelled and is no longer within its grace period.

Returns whether the provided subcription has been cancelled but has time before it ends.

Returns whether the provided subscription has multiple subscription items (prices).

Returns whether the provided subscription has only a single subscription item (price).

Increments the quantity of a subscription item. Defaults to incrementing the first item. Defaults to incrementing by one.

examples

Examples

# this would update the first subscription item's quantity by one
# useful for single price subscriptions
subscription = increment(subscription)

# you can also specify a price and quantity to increment by
subscription = increment(subscription, price_id: "price_123", quantity: 2)

# can pass any valid Stripe.SubscriptionItem.update/2 params
subscription = increment(subscription, stripe: %{ prorate: false })

Returns whether the provided subscription is recurring, which is the case if it has no end date and is not on a trial.

Removes prices from a subscription. Returns the subscription with the items loaded.

Raises if all prices are removed from a subscription.

examples

Examples

remove_prices(subscription, prices: [price_id])

Resumes a cancelled subscription. The grace period must not have ended in order for this to succeed.

examples

Examples

subscription = resume(subscription)

# can pass any valid Stripe.Subscription.update/2 params
subscription = resume(subscription, stripe: %{ prorate: false })

Sets the quantity of a subscription item. Defaults to setting the first item. Defaults to setting to one.

examples

Examples

# this would update the first subscription item's quantity to one
# useful for single price subscriptions
subscription = set_quantity(subscription)

# you can also specify a price and quantity to set to
subscription = set_quantity(subscription, price_id: "price_123", quantity: 2)

# can pass any valid Stripe.SubscriptionItem.update/2 params
subscription = set_quantity(subscription, stripe: %{ prorate: false })

Turns an array of stripe subscription items into database subscription structs. Meant for internal use.

examples

Examples

subscription =
  subscription_struct_from_stripe_subscription(MyApp.Subscriptions.Subscription, stripe_subscription)
  |> MyApp.Repo.insert()

subscription_items =
  subscription_item_structs_from_stripe_items(stripe_subscription.items.data, subscription)
  |> Enum.each(&MyApp.Repo.insert/1)

Returns all of the database subscription items for a subscription.

Turns a stripe subscription object into a database subscription without committing it. Meant for internal use.

examples

Examples

subscription =
  subscription_struct_from_stripe_subscription(MyApp.Subscriptions.Subscription, stripe_subscription)
  |> MyApp.Repo.insert()

Returns whether the provided subscription is on a trial that hasn't expired.

Returns whether the provided subscription is valid, which is the case if any of the following checks are true:

• Bling.Subscriptions.active?/1
• Bling.Subscriptions.trial?/1
• Bling.Subscriptions.grace_period?/1