CorvoNfse.Types.Billing.PlanResponse (Corvo NFS-e v0.1.1)

Copy Markdown View Source

Wire shape of GET /billing/plan (nested snake_case objects).

Summary

Types

t()

Wire shape of GET /billing/plan. plan, subscription and usage are plain JSON snake_case string-keyed objects

Types

t()

@type t() :: %CorvoNfse.Types.Billing.PlanResponse{
  plan: %{optional(String.t()) => term()},
  subscription: %{optional(String.t()) => term()},
  usage: %{optional(String.t()) => term()}
}

Wire shape of GET /billing/plan. plan, subscription and usage are plain JSON snake_case string-keyed objects:

  • plan - slug, name, monthly_allowance, daily_limit, max_active_companies, monthly_price_cents
  • subscription - status, paid_until, cancel_at_period_end, scheduled_plan, blocked
  • usage - overage_units, overage_amount_cents, hard_limit, credits_used, credits_reserved, credits_remaining, monthly_allowance, daily_usage, daily_limit, active_companies, max_active_companies, period_start, period_end