Stripe.Subscription (stripity_stripe_fb v2.13.1) View Source

Work with Stripe subscription objects.

You can:

Create a subscription
Retrieve a subscription
Update a subscription
Delete a subscription

Stripe API reference: https://stripe.com/docs/api#subscription

Link to this section Summary

Types

pause_collection()

pending_invoice_item_interval()

pending_update()

t()

Functions

create(params, opts \\ [])

Create a subscription.

delete(id)

Delete a subscription.

delete(id, opts)

Delete a subscription.

delete(id, params, opts)

Delete a subscription.

delete_discount(id, opts \\ [])

Deletes the discount on a subscription.

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

List all subscriptions.

retrieve(id, opts \\ [])

Retrieve a subscription.

update(id, params, opts \\ [])

Update a subscription.

Link to this section Types

pause_collection()

Specs

pause_collection() :: %{behavior: String.t(), resumes_at: Stripe.timestamp()}

pending_invoice_item_interval()

Specs

pending_invoice_item_interval() :: %{
  interval: String.t(),
  interval_count: integer()
}

pending_update()

Specs

pending_update() :: %{
  billing_cycle_anchor: Stripe.timestamp(),
  expires_at: Stripe.timestamp(),
  subscription_items: [Stripe.SubscriptionItem.t()],
  trial_end: Stripe.timestamp(),
  trial_from_plan: boolean()
}

t()

Specs

t() :: %Stripe.Subscription{
  application_fee_percent: float() | nil,
  automatic_tax: map(),
  billing_cycle_anchor: Stripe.timestamp() | nil,
  billing_thresholds: map() | nil,
  cancel_at: Stripe.timestamp() | nil,
  cancel_at_period_end: boolean(),
  canceled_at: Stripe.timestamp() | nil,
  collection_method: String.t() | nil,
  collection_method_cycle_anchor: Stripe.timestamp() | nil,
  collection_method_thresholds:
    Stripe.Types.collection_method_thresholds() | nil,
  created: Stripe.timestamp(),
  current_period_end: Stripe.timestamp() | nil,
  current_period_start: Stripe.timestamp() | nil,
  customer: Stripe.id() | Stripe.Customer.t(),
  days_until_due: integer() | nil,
  default_payment_method: Stripe.id() | Stripe.PaymentMethod.t() | nil,
  default_source: Stripe.id() | Stripe.Source.t() | nil,
  default_tax_rates: [Stripe.TaxRate],
  discount: Stripe.Discount.t() | nil,
  ended_at: Stripe.timestamp() | nil,
  id: Stripe.id(),
  items: Stripe.List.t(Stripe.SubscriptionItem.t()),
  latest_invoice: Stripe.id() | Stripe.Invoice.t() | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  next_pending_invoice_item_invoice: Stripe.timestamp() | nil,
  object: String.t(),
  pause_collection: pause_collection() | nil,
  pending_invoice_item_interval: pending_invoice_item_interval() | nil,
  pending_setup_intent: Stripe.SetupIntent.t() | nil,
  pending_update: pending_update() | nil,
  plan: Stripe.Plan.t() | nil,
  quantity: integer() | nil,
  schedule: String.t() | nil,
  start_date: Stripe.timestamp(),
  status: String.t(),
  tax_percent: float() | nil,
  transfer_data: map(),
  trial_end: Stripe.timestamp() | nil,
  trial_start: Stripe.timestamp() | nil
}

Link to this section Functions

create(params, opts \\ [])

Specs

create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       :customer => Stripe.id() | Stripe.Customer.t(),
       optional(:application_fee_percent) => integer(),
       optional(:billing_cycle_anchor) => Stripe.timestamp(),
       optional(:billing_thresholds) => map(),
       optional(:collection_method) => String.t(),
       optional(:collection_method_cycle_anchor) => Stripe.timestamp(),
       optional(:cancel_at) => Stripe.timestamp(),
       optional(:cancel_at_period_end) => boolean(),
       optional(:collection_method) => String.t(),
       optional(:coupon) => Stripe.id() | Stripe.Coupon.t(),
       optional(:days_until_due) => non_neg_integer(),
       :items => [
         %{
           optional(:plan) => Stripe.id() | Stripe.Plan.t(),
           optional(:price) => Stripe.id() | Stripe.Price.t(),
           optional(:billing_methods) => map(),
           optional(:metadata) => map(),
           optional(:quantity) => non_neg_integer(),
           optional(:tax_rates) => list()
         }
       ],
       optional(:default_payment_method) => Stripe.id(),
       optional(:default_tax_rates) => [Stripe.id()],
       optional(:expand) => [String.t()],
       optional(:metadata) => Stripe.Types.metadata(),
       optional(:payment_behavior) => String.t(),
       optional(:prorate) => boolean(),
       optional(:proration_behavior) => String.t(),
       optional(:promotion_code) => Stripe.id(),
       optional(:tax_percent) => float(),
       optional(:trial_end) => Stripe.timestamp(),
       optional(:trial_from_plan) => boolean(),
       optional(:trial_period_days) => non_neg_integer()
     }

Create a subscription.

delete(id)

Specs

delete(Stripe.id() | t()) :: {:ok, t()} | {:error, Stripe.Error.t()}

Delete a subscription.

Takes the subscription id or a Stripe.Subscription struct.

delete(id, opts)

Specs

delete(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

delete(Stripe.id() | t(), %{at_period_end: true}) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

delete(Stripe.id() | t(), params) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:invoice_now) => boolean(),
       optional(:prorate) => boolean()
     }

Delete a subscription.

Takes the subscription id or a Stripe.Subscription struct.

Second argument can be a map of cancellation params, such as invoice_now, or a list of options, such as custom API key.

Deprecated Usage

Passing a map with at_period_end: true to Subscription.delete/2 is deprecated. Use Subscription.update/2 with cancel_at_period_end: true instead.

delete(id, params, opts)

Specs

delete(Stripe.id() | t(), %{at_period_end: true}, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

delete(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:invoice_now) => boolean(),
       optional(:prorate) => boolean()
     }

Delete a subscription.

Takes the subscription id or a Stripe.Subscription struct.

Second argument is a map of cancellation params, such as invoice_now.

Third argument is a list of options, such as custom API key.

delete_discount(id, opts \\ [])

Specs

delete_discount(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Deletes the discount on a subscription.

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

Specs

list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params: %{
       optional(:collection_method) => String.t(),
       optional(:created) => Stripe.date_query(),
       optional(:customer) => Stripe.Customer.t() | Stripe.id(),
       optional(:ending_before) => t() | Stripe.id(),
       optional(:limit) => 1..100,
       optional(:plan) => Stripe.Plan.t() | Stripe.id(),
       optional(:price) => Stripe.Price.t() | Stripe.id(),
       optional(:starting_after) => t() | Stripe.id(),
       optional(:status) => String.t()
     }

List all subscriptions.

retrieve(id, opts \\ [])

Specs

retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a subscription.

update(id, params, opts \\ [])

Specs

update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:application_fee_percent) => float(),
       optional(:billing_cycle_anchor) => Stripe.timestamp(),
       optional(:billing_thresholds) => map(),
       optional(:collection_method) => String.t(),
       optional(:collection_method_cycle_anchor) => Stripe.timestamp(),
       optional(:cancel_at) => Stripe.timestamp(),
       optional(:cancel_at_period_end) => boolean(),
       optional(:collection_method) => String.t(),
       optional(:coupon) => Stripe.id() | Stripe.Coupon.t(),
       optional(:days_until_due) => non_neg_integer(),
       optional(:items) => [
         %{
           optional(:id) => Stripe.id() | binary(),
           optional(:plan) => Stripe.id() | Stripe.Plan.t(),
           optional(:price) => Stripe.id() | Stripe.Price.t(),
           optional(:billing_methods) => map(),
           optional(:metadata) => map(),
           optional(:quantity) => non_neg_integer(),
           optional(:tax_rates) => list()
         }
       ],
       optional(:default_payment_method) => Stripe.id(),
       optional(:default_tax_rates) => [Stripe.id()],
       optional(:metadata) => Stripe.Types.metadata(),
       optional(:pause_collection) => pause_collection(),
       optional(:prorate) => boolean(),
       optional(:proration_behavior) => String.t(),
       optional(:proration_date) => Stripe.timestamp(),
       optional(:tax_percent) => float(),
       optional(:trial_end) => Stripe.timestamp(),
       optional(:trial_from_plan) => boolean()
     }

Update a subscription.

Takes the id and a map of changes.