Packages
stripity_stripe
2.0.0-alpha.9
3.3.2
3.3.1
3.2.0
3.1.1
3.1.0
3.0.0
2.17.3
2.17.2
2.17.1
2.17.0
2.16.0
2.15.1
2.15.0
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.0
2.5.0
2.4.0
2.3.0
2.2.3
2.2.2
2.2.1
2.2.0
2.1.0
2.0.1
2.0.0
2.0.0-alpha.11
2.0.0-alpha.10
2.0.0-alpha.9
2.0.0-alpha.8
2.0.0-alpha.7
2.0.0-alpha.6
2.0.0-alpha.5
2.0.0-alpha.4
2.0.0-alpha.3
2.0.0-alpha.2
2.0.0-alpha.1
1.6.2
1.6.1
1.6.0
1.4.0
1.3.0
1.2.0
1.1.0
0.5.0
0.4.0
0.3.0
0.2.0
A Stripe client for Elixir.
Current section
Files
Jump to
Current section
Files
lib/stripe/subscription.ex
defmodule Stripe.Subscription do
@moduledoc """
Work with Stripe subscription objects.
You can:
- Create a subscription
- Retrieve a subscription
- Update a subscription
- Delete a subscription
Does not yet render lists or take options.
Stripe API reference: https://stripe.com/docs/api#subscription
"""
@type t :: %__MODULE__{}
defstruct [
:id, :object,
:application_fee_percent, :cancel_at_period_end, :canceled_at,
:created, :current_period_end, :current_period_start, :customer,
:ended_at, :livemode, :metadata, :plan, :quantity, :source,
:start, :status, :tax_percent, :trial_end, :trial_start
]
@plural_endpoint "subscriptions"
@schema %{
application_fee_percent: [:create, :retrieve, :update],
cancel_at_period_end: [:retrieve],
canceled_at: [:retrieve],
coupon: [:create, :update],
created: [:retrieve],
current_period_end: [:retrieve],
current_period_start: [:retrieve],
customer: [:create, :retrieve],
discount: [:retrieve],
ended_at: [:retrieve],
id: [:retrieve],
livemode: [:retrieve],
metadata: [:create, :retrieve, :update],
object: [:retrieve],
plan: [:create, :retrieve, :update],
prorate: [:create],
quantity: [:create, :retrieve, :update],
source: [:create, :update],
start: [:retrieve],
status: [:retrieve],
tax_percent: [:create, :retrieve, :update],
trial_end: [:create, :retrieve, :update],
trial_period_days: [:create],
trial_start: [:create, :retrieve]
}
@nullable_keys [
:metadata
]
@doc """
Create a subscription.
"""
@spec create(map, Keyword.t) :: {:ok, t} | {:error, Stripe.api_error_struct}
def create(changes, opts \\ []) do
Stripe.Request.create(@plural_endpoint, changes, @schema, opts)
end
@doc """
Retrieve a subscription.
"""
@spec retrieve(binary, Keyword.t) :: {:ok, t} | {:error, Stripe.api_error_struct}
def retrieve(id, opts \\ []) do
endpoint = @plural_endpoint <> "/" <> id
Stripe.Request.retrieve(endpoint, opts)
end
@doc """
Update a subscription.
Takes the `id` and a map of changes.
"""
@spec update(binary, map, list) :: {:ok, t} | {:error, Stripe.api_error_struct}
def update(id, changes, opts \\ []) do
endpoint = @plural_endpoint <> "/" <> id
Stripe.Request.update(endpoint, changes, @schema, @nullable_keys, opts)
end
@doc """
Delete a subscription.
Takes the `id` and an optional map of `params`.
"""
@spec delete(binary, map, list) :: :ok | {:error, Stripe.api_error_struct}
def delete(id, params \\ %{}, opts \\ []) do
endpoint = @plural_endpoint <> "/" <> id
Stripe.Request.delete(endpoint, params, opts)
end
@doc """
List all subscriptions.
"""
@spec list(map, Keyword.t) :: {:ok, Stripe.List.t} | {:error, Stripe.api_error_struct}
def list(params \\ %{}, opts \\ []) do
endpoint = @plural_endpoint
Stripe.Request.retrieve(endpoint, opts)
end
end