stripity_stripe v2.0.0-alpha.1 Stripe.Subscription

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

Summary

Types

stripe_delete_response()

stripe_response()

t()

Functions

create(subscription, opts \\ [])

Create a subscription

delete(id, opts \\ [])

Delete a subscription

retrieve(id, opts \\ [])

Retrieve a subscription

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

Update a subscription

Types

stripe_delete_response()

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

stripe_response()

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

t()

t :: %Stripe.Subscription{application_fee_percent: term, cancel_at_period_end: term, canceled_at: term, created: term, current_period_end: term, current_period_start: term, customer: term, discount: term, ended_at: term, id: term, livemode: term, metadata: term, plan: term, quantity: term, source: term, start: term, status: term, tax_percent: term, trial_end: term, trial_start: term}

Functions

create(subscription, opts \\ [])

create(t, Keyword.t) :: stripe_response

Create a subscription.

delete(id, opts \\ [])

delete(binary, list) :: stripe_delete_response

Delete a subscription.

retrieve(id, opts \\ [])

retrieve(binary, Keyword.t) :: stripe_response

Retrieve a subscription.

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

update(t, map, list) :: stripe_response

Update a subscription.

Takes the id and a map of changes.