Search documentation of polar_express

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

Copy Markdown View Source

ProductCreateOneTime

## Summary

### Types

t()

### Functions

schema_name()

## Types

# t()

    @type t() :: %PolarExpress.Schemas.ProductCreateOneTime{
      attached_custom_fields:
        [PolarExpress.Schemas.AttachedCustomFieldCreate.t()] | nil,
      description: String.t() | nil,
      medias: [String.t()] | nil,
      metadata:
        %{
          required(String.t()) => String.t() | integer() | float() | boolean() | nil
        }
        | nil,
      name: String.t() | nil,
      organization_id: String.t() | nil,
      prices:
        [
          PolarExpress.Schemas.ProductPriceFixedCreate.t()
          | PolarExpress.Schemas.ProductPriceCustomCreate.t()
          | PolarExpress.Schemas.ProductPriceFreeCreate.t()
          | PolarExpress.Schemas.ProductPriceSeatBasedCreate.t()
          | PolarExpress.Schemas.ProductPriceMeteredUnitCreate.t()
        ]
        | nil,
      recurring_interval: term(),
      recurring_interval_count: term(),
      visibility: PolarExpress.Schemas.ProductVisibility.t() | nil
    }

- `attached_custom_fields` - List of custom fields to attach.
- `description` - The description of the product. Nullable.
- `medias` - List of file IDs. Each one must be on the same organization as the product, of type `product_media` and correctly uploaded. Nullable.
- `metadata` - Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean

You can store up to 50 key-value pairs.

- `name` - The name of the product.
- `organization_id` - The ID of the organization owning the product. Required unless you use an organization token. Nullable.
- `prices` - List of available prices for this product. It should contain at most one static price (fixed, custom or free), and any number of metered prices. Metered prices are not supported on one-time purchase products.
- `recurring_interval` - States that the product is a one-time purchase.
- `recurring_interval_count` - One-time products don't have a recurring interval count.
- `visibility` - The visibility of the product.

## Functions

# schema_name()