polar_express

# File generated from our OpenAPI spec
defmodule PolarExpress.Resources.Subscriptions do
  @moduledoc """
  Subscriptions

  Subscriptions API operations.
  """

  @typedoc """
  * `amount` - The amount of the subscription.
  * `cancel_at_period_end` - Whether the subscription will be canceled at the end of the current period.
  * `canceled_at` - The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.
  * `checkout_id`
  * `created_at` - Creation timestamp of the object. Format: date-time.
  * `currency` - The currency of the subscription.
  * `current_period_end` - The end timestamp of the current billing period. Format: date-time.
  * `current_period_start` - The start timestamp of the current billing period. Format: date-time.
  * `custom_field_data` - Key-value object storing custom field values.
  * `customer`
  * `customer_cancellation_comment`
  * `customer_cancellation_reason`
  * `customer_id` - The ID of the subscribed customer. Format: uuid4.
  * `discount`
  * `discount_id` - The ID of the applied discount, if any.
  * `ended_at` - The timestamp when the subscription ended.
  * `ends_at` - The timestamp when the subscription will end.
  * `id` - The ID of the object. Format: uuid4.
  * `metadata`
  * `meters` - List of meters associated with the subscription.
  * `modified_at` - Last modification timestamp of the object.
  * `pending_update` - Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update.
  * `prices` - List of enabled prices for the subscription.
  * `product`
  * `product_id` - The ID of the subscribed product. Format: uuid4.
  * `recurring_interval` - The interval at which the subscription recurs.
  * `recurring_interval_count` - Number of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on.
  * `seats` - The number of seats for seat-based subscriptions. None for non-seat subscriptions.
  * `started_at` - The timestamp when the subscription started.
  * `status` - The status of the subscription.
  * `trial_end` - The end timestamp of the trial period, if any.
  * `trial_start` - The start timestamp of the trial period, if any.
  """
  @type t :: %__MODULE__{
          amount: integer() | nil,
          cancel_at_period_end: boolean() | nil,
          canceled_at: term() | nil,
          checkout_id: term() | nil,
          created_at: String.t() | nil,
          currency: String.t() | nil,
          current_period_end: String.t() | nil,
          current_period_start: String.t() | nil,
          custom_field_data: term() | nil,
          customer: map() | nil,
          customer_cancellation_comment: term() | nil,
          customer_cancellation_reason: term() | nil,
          customer_id: String.t() | nil,
          discount: term() | nil,
          discount_id: term() | nil,
          ended_at: term() | nil,
          ends_at: term() | nil,
          id: String.t() | nil,
          metadata: map() | nil,
          meters: [map()] | nil,
          modified_at: term() | nil,
          pending_update: term() | nil,
          prices: [term()] | nil,
          product: map() | nil,
          product_id: String.t() | nil,
          recurring_interval: map() | nil,
          recurring_interval_count: integer() | nil,
          seats: term() | nil,
          started_at: term() | nil,
          status: map() | nil,
          trial_end: term() | nil,
          trial_start: term() | nil
        }

  defstruct [
    :amount,
    :cancel_at_period_end,
    :canceled_at,
    :checkout_id,
    :created_at,
    :currency,
    :current_period_end,
    :current_period_start,
    :custom_field_data,
    :customer,
    :customer_cancellation_comment,
    :customer_cancellation_reason,
    :customer_id,
    :discount,
    :discount_id,
    :ended_at,
    :ends_at,
    :id,
    :metadata,
    :meters,
    :modified_at,
    :pending_update,
    :prices,
    :product,
    :product_id,
    :recurring_interval,
    :recurring_interval_count,
    :seats,
    :started_at,
    :status,
    :trial_end,
    :trial_start
  ]

  @object_name "subscriptions"
  def object_name, do: @object_name
end