stripity_stripe v2.0.0-alpha.1 Stripe.Plan

Work with Stripe plan objects.

You can:

Create a plan
Retrieve a plan
Update a plan
Delete a plan

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

Summary

Types

stripe_delete_response()

stripe_response()

t()

Functions

create(plan, opts \\ [])

Create a plan

delete(id, opts \\ [])

Delete a plan

retrieve(id, opts \\ [])

Retrieve a plan

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

Update a plan

Types

stripe_delete_response()

stripe_delete_response :: :ok | {:error, Exception.t}

stripe_response()

stripe_response :: {:ok, t} | {:error, Exception.t}

t()

t :: %Stripe.Plan{amount: term, created: term, currency: term, id: term, interval: term, interval_count: term, livemode: term, metadata: term, name: term, statement_descriptor: term, trial_period_days: term}

Functions

create(plan, opts \\ [])

create(t, Keyword.t) :: stripe_response

Create a plan.

delete(id, opts \\ [])

delete(binary, list) :: stripe_delete_response

Delete a plan.

retrieve(id, opts \\ [])

retrieve(binary, Keyword.t) :: stripe_response

Retrieve a plan.

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

update(t, map, list) :: stripe_response

Update a plan.

Takes the id and a map of changes.