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_opts() ::
  {:starting_after, String.t()}
  | {:product, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:created, String.t()}
  | {:active, String.t()}
@type get_plans_plan_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

delete_plans_plan(client, body, plan)

View Source
@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>

Link to this function

get_plans(client, opts \\ [])

View Source
@spec get_plans(client :: ExOAPI.Client.t(), [get_plans_opts()]) ::
  {:ok, any()} | {:error, any()}

description: <p>Returns a list of your plans.</p>

Link to this function

get_plans_plan(client, plan, opts \\ [])

View Source
@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>

Link to this function

post_plans(client, body)

View Source
@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>

Link to this function

post_plans_plan(client, body, plan)

View Source
@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>