Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 5.55 KB

price.md

File metadata and controls

136 lines (100 loc) · 5.55 KB
Raw
page_title subcategory description
epilot-product_price Data Source - terraform-provider-epilot-product
Price DataSource

epilot-product_price (Data Source)

Price DataSource

Example Usage

data "epilot-product_price" "my_price" {
  hydrate = true
  strict  = true
}

Schema

Optional

  • hydrate (Boolean) Hydrates entities in relations when passed true
  • strict (Boolean) When passed true, the response will contain only fields that match the schema, with non-matching fields included in __additional

Read-Only

  • acl (Attributes) Access control list (ACL) for an entity. Defines sharing access to external orgs or users. (see below for nested schema)
  • active (Boolean) Whether the price can be used for new purchases.
  • additional (Map of String) Additional fields that are not part of the schema
  • billing_duration_amount (Number) The billing period duration
  • billing_duration_unit (String) The billing period duration unit
  • created_at (String)
  • description (String) A brief description of the price.
  • files (Attributes) (see below for nested schema)
  • id (String) The ID of this resource.
  • is_composite_price (Boolean) The flag for prices that contain price components.
  • is_tax_inclusive (Boolean) Specifies whether the price is considered inclusive of taxes or not.
  • long_description (String) A detailed description of the price. This is shown on the order document and order table. Multi-line supported.
  • manifest (List of String) Manifest ID used to create/update the entity
  • notice_time_amount (Number) The notice period duration
  • notice_time_unit (String) The notice period duration unit
  • org (String) Organization Id the entity belongs to
  • owners (Attributes List) (see below for nested schema)
  • price_components (Attributes) A set of price components that define the composite price. (see below for nested schema)
  • price_display_in_journeys (String) Defines the way the price amount is display in epilot journeys.
  • pricing_model (String) Describes how to compute the price per period. Either per_unit, tiered_graduated or tiered_volume.
  • per_unit indicates that the fixed amount (specified in unit_amount or unit_amount_decimal) will be charged per unit in quantity
  • tiered_graduated indicates that the unit pricing will be computed using tiers attribute. The customer pays the price per unit in every range their purchase rises through.
  • tiered_volume indicates that the unit pricing will be computed using tiers attribute. The customer pays the same unit price for all purchased units.
  • tiered_flatfee While similar to tiered_volume, tiered flat fee charges for the same price (flat) for the entire range instead using the unit price to multiply the quantity.
  • renewal_duration_amount (Number) The renewal period duration
  • renewal_duration_unit (String) The renewal period duration unit
  • schema (String)
  • tags (List of String)
  • tax (String) Parsed as JSON.
  • termination_time_amount (Number) The termination period duration
  • termination_time_unit (String) The termination period duration unit
  • tiers (Attributes List) Defines an array of tiers. Each tier has an upper bound, an unit amount and a flat fee. (see below for nested schema)
  • title (String)
  • type (String) One of one_time or recurring depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
  • unit (String) The unit of measurement used for display purposes and possibly for calculations when the price is variable.
  • unit_amount (Number) The unit amount in cents to be charged, represented as a whole integer if possible.
  • unit_amount_currency (String) Three-letter ISO currency code, in lowercase.
  • unit_amount_decimal (String) The unit amount in cents to be charged, represented as a decimal string with at most 12 decimal places.
  • updated_at (String)
  • variable_price (Boolean) The flag for prices that can be influenced by external variables such as user input.

Nested Schema for acl

Read-Only:

  • delete (List of String)
  • edit (List of String)
  • view (List of String)

Nested Schema for files

Read-Only:

Nested Schema for files.dollar_relation

Read-Only:

  • entity_id (String)
  • tags (List of String)

Nested Schema for owners

Read-Only:

  • org_id (String)
  • user_id (String)

Nested Schema for price_components

Read-Only:

Nested Schema for price_components.dollar_relation

Read-Only:

  • entity_id (String) The id of the price component
  • tags (List of String) An arbitrary set of tags attached to the composite price - component relation

Nested Schema for tiers

Read-Only:

  • display_mode (String)
  • flat_fee_amount (Number)
  • flat_fee_amount_decimal (String)
  • unit_amount (Number)
  • unit_amount_decimal (String)
  • up_to (Number)