exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.Plans (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_plans_opts()
get_plans_plan_opts()

Functions

delete_plans_plan(client, body, plan)

description: <p>Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.</p>

get_plans(client, opts \\ [])

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

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

description: <p>Retrieves the plan with the given ID.</p>

post_plans(client, body)

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>

post_plans_plan(client, body, plan)

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

Link to this type

get_plans_opts()

View Source 
@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()}
Link to this type

get_plans_plan_opts()

View Source 
@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,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.DeletedPlan.t()
   | map()}
  | {: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,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.Plan.t()]
     }
   | map()}
  | {: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,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Plan.t() | map()}
  | {: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 ::
    %{
      usage_type: String.t() | :licensed | :metered,
      trial_period_days: integer(),
      transform_usage: %{round: String.t() | :down | :up, divide_by: integer()},
      tiers_mode: String.t() | :graduated | :volume,
      tiers: [
        %{
          up_to: integer() | String.t() | :inf,
          unit_amount_decimal: String.t(),
          unit_amount: integer(),
          flat_amount_decimal: String.t(),
          flat_amount: integer()
        }
      ],
      product:
        String.t()
        | %{
            unit_label: String.t(),
            tax_code: String.t(),
            statement_descriptor: String.t(),
            name: String.t(),
            metadata: map(),
            id: String.t(),
            active: boolean()
          },
      nickname: String.t(),
      metadata: String.t() | map(),
      interval_count: integer(),
      interval: String.t() | :day | :month | :week | :year,
      id: String.t(),
      expand: [String.t()],
      currency: String.t(),
      billing_scheme: String.t() | :per_unit | :tiered,
      amount_decimal: String.t(),
      amount: integer(),
      aggregate_usage:
        String.t() | :last_during_period | :last_ever | :max | :sum,
      active: boolean()
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Plan.t() | map()}
  | {: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 ::
    %{
      trial_period_days: integer(),
      product: String.t(),
      nickname: String.t(),
      metadata: String.t() | map(),
      expand: [String.t()],
      active: boolean()
    }
    | map(),
  plan :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t() | ExOAPI.Stripe.Schemas.Plan.t() | map()}
  | {: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>