View Source ExOAPI.Stripe.SDK.Plans (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>
description: <p>Returns a list of your plans.</p>
description: <p>Retrieves the plan with the given ID.</p>
description: <p>You can now model subscriptions more flexibly using the <a href="#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>
description: <p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.</p>
Link to this section Types
@type get_plans_plan_opts() :: {:expand, String.t()}
Link to this section Functions
@spec delete_plans_plan( client :: ExOAPI.Client.t(), body :: map(), plan :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>
@spec get_plans(client :: ExOAPI.Client.t(), [get_plans_opts()]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of your plans.</p>
@spec get_plans_plan( client :: ExOAPI.Client.t(), plan :: String.t(), [get_plans_plan_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the plan with the given ID.</p>
@spec post_plans(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>You can now model subscriptions more flexibly using the <a href="#prices">Prices API</a>. It replaces the Plans API and is backwards compatible to simplify your migration.</p>
@spec post_plans_plan(client :: ExOAPI.Client.t(), body :: map(), plan :: String.t()) :: {:ok, any()} | {:error, any()}
description: <p>Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.</p>