Search documentation of polar_express

# PolarExpress.Schemas.OrderProduct (polar_express v0.1.5)

Copy Markdown View Source

OrderProduct

## Summary

### Types

t()

### Functions

schema_name()

## Types

# t()

    @type t() :: %PolarExpress.Schemas.OrderProduct{
      created_at: DateTime.t() | nil,
      description: String.t() | nil,
      id: String.t() | nil,
      is_archived: boolean() | nil,
      is_recurring: boolean() | nil,
      metadata: PolarExpress.Schemas.MetadataOutputType.t() | nil,
      modified_at: DateTime.t() | nil,
      name: String.t() | nil,
      organization_id: String.t() | nil,
      recurring_interval:
        PolarExpress.Schemas.SubscriptionRecurringInterval.t() | nil,
      recurring_interval_count: integer() | nil,
      trial_interval: PolarExpress.Schemas.TrialInterval.t() | nil,
      trial_interval_count: integer() | nil,
      visibility: PolarExpress.Schemas.ProductVisibility.t() | nil
    }

- `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.

## Functions

# schema_name()