PolarExpress.Schemas.BenefitMeterCreditCreate (polar_express v0.1.5)

Copy Markdown View Source

BenefitMeterCreditCreate

Schema to create a benefit of type meter_unit.

Summary

Types

t()

@type t() :: %PolarExpress.Schemas.BenefitMeterCreditCreate{
  description: String.t() | nil,
  metadata:
    %{
      required(String.t()) => String.t() | integer() | float() | boolean() | nil
    }
    | nil,
  organization_id: String.t() | nil,
  properties: PolarExpress.Schemas.BenefitMeterCreditCreateProperties.t() | nil,
  type: String.t() | nil
}
  • description - The description of the benefit. Will be displayed on products having this benefit. Max length: 42.
  • 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.

  • organization_id - The ID of the organization owning the benefit. Required unless you use an organization token. Nullable.
  • properties
  • type

Functions

schema_name()