View Source Stripe.Entitlements.ActiveEntitlement (stripity_stripe v3.3.1)

An active entitlement describes access to a feature for a customer.

Summary

Types

t()

The entitlements.active_entitlement type.

Functions

list(params \\ %{}, opts \\ [])

Retrieve a list of active entitlements for a customer

retrieve(id, params \\ %{}, opts \\ [])

Retrieve an active entitlement

Types

t()

@type t() :: %Stripe.Entitlements.ActiveEntitlement{
  feature: binary() | Stripe.Entitlements.Feature.t(),
  id: binary(),
  livemode: boolean(),
  lookup_key: binary(),
  object: binary()
}

The entitlements.active_entitlement type.

feature The Feature that the customer is entitled to.
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
lookup_key A unique key you provide as your own system identifier. This may be up to 80 characters.
object String representing the object's type. Objects of the same type share the same value.

Functions

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:customer) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieve a list of active entitlements for a customer

Details

Method: get
Path: /v1/entitlements/active_entitlements

retrieve(id, params \\ %{}, opts \\ [])

@spec retrieve(
  id :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieve an active entitlement

Details

Method: get
Path: /v1/entitlements/active_entitlements/{id}