exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Product (exoapi_stripe v0.1.4)

description: Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices

:active :: :boolean

Whether the product is currently available for purchase.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:description :: :string

The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

:id :: :string

Unique identifier for the object.

::images :: :string

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:name :: :string

The product's name, meant to be displayable to the customer.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:package_dimensions :: ExOAPI.Stripe.Schemas.PackageDimensions

The dimensions of this product for shipping purposes.

:shippable :: :boolean

Whether this product is shipped (i.e., physical goods).

:statement_descriptor :: :string

Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used.

:tax_code :: ExOAPI.Stripe.Schemas.TaxCode | :string

A tax code ID.

:unit_label :: :string

A label that represents units of this product in Stripe and on customers’ receipts and invoices. When set, this will be included in associated invoice line item descriptions.

:updated :: :integer

Time at which the object was last updated. Measured in seconds since the Unix epoch.

:url :: :string

A URL of a publicly-accessible webpage for this product.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Product{
  active: boolean() | nil,
  created: integer() | nil,
  description: String.t() | nil,
  id: String.t() | nil,
  images: [String.t()] | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  name: String.t() | nil,
  object: :product | nil,
  package_dimensions: ExOAPI.EctoTypes.AnyOf.t() | nil,
  shippable: boolean() | nil,
  statement_descriptor: String.t() | nil,
  tax_code: ExOAPI.EctoTypes.AnyOf.t() | nil,
  unit_label: String.t() | nil,
  updated: integer() | nil,
  url: String.t() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()