PolarExpress.Schemas.DiscountProduct (polar_express v0.2.2)

DiscountProduct

A product that a discount can be applied to.

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.DiscountProduct{
  created_at: term(),
  description: term(),
  id: term(),
  is_archived: term(),
  is_recurring: term(),
  metadata: term(),
  modified_at: term(),
  name: term(),
  organization_id: term(),
  recurring_interval: term(),
  recurring_interval_count: term(),
  trial_interval: term(),
  trial_interval_count: term(),
  visibility: term()
}

created_at - Creation timestamp of the object. Format: date-time.
description - The description of the product. Nullable.
id - The ID of the object. Format: uuid4.
is_archived - Whether the product is archived and no longer available.
is_recurring - Whether the product is a subscription.
metadata
modified_at - Last modification timestamp of the object. Nullable.
name - The name of the product.
organization_id - The ID of the organization owning the product. Format: uuid4.
recurring_interval - The recurring interval of the product. If None, the product is a one-time purchase. Nullable.
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. None for one-time products. Nullable.
trial_interval - The interval unit for the trial period. Nullable.
trial_interval_count - The number of interval units for the trial period. Nullable.
visibility - The visibility of the product.