RevenueCat (revenue_cat v0.1.0)

RevenueCat V2 API client focused on entitlement checks and customer deletion.

Supports global config, per-call overrides, and reusable client structs.

Summary

option_key()

options()

t()

Deletes a customer in RevenueCat.

Deletes a customer using per-call options.

Checks whether a customer currently has an active entitlement.

Checks active entitlement using per-call options.

new(opts \\ [])

Builds a reusable client struct.

@type option_key() :: :secret_api_key | :project_id | :base_url | :req_options

@type options() :: [{option_key(), term()}]

@type t() :: %RevenueCat{
  base_url: String.t(),
  project_id: nil | String.t(),
  req_options: keyword(),
  secret_api_key: nil | String.t()
}

Deletes a customer in RevenueCat.

Returns :ok when RevenueCat responds with 200, 204, or 404.

@spec delete_customer(String.t(), options()) :: :ok | {:error, term()}

@spec delete_customer(t(), String.t()) :: :ok | {:error, term()}

Deletes a customer using per-call options.

Options override app config for this call.

Checks whether a customer currently has an active entitlement.

configured_entitlement may be an entitlement ID, lookup key, or display name. Returns {:ok, true | false} on successful API resolution.

@spec has_active_entitlement(String.t(), String.t(), options()) ::
  {:ok, boolean()} | {:error, term()}

@spec has_active_entitlement(t(), String.t(), String.t()) ::
  {:ok, boolean()} | {:error, term()}

Checks active entitlement using per-call options.

Options override app config for this call.

@spec new(options()) :: t()

Builds a reusable client struct.

Options: