RecurlyClient.Types.AddOnUpdate

Contains the types generated from the schema AddOnUpdate

Documentation

data AddOnUpdate

Defines the object schema located at components.schemas.AddOnUpdate in the specification.

Full add-on details.

Constructors

AddOnUpdate

Fields

• addOnUpdateAccounting_code :: Maybe Text

  accounting_code: Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If an `Item` is associated to the `AddOn` then `accounting code` must be absent.

  Constraints:

  • Maximum length of 20
  • Must match pattern '/^[a-z0-9_+-]+$/'
• addOnUpdateAvalara_service_type :: Maybe Int

  avalara_service_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_service_type` must be absent.

  Constraints:

  • Minimum of 0.0
• addOnUpdateAvalara_transaction_type :: Maybe Int

  avalara_transaction_type: Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the add-on is taxed. Refer to the documentation for more available t/s types. If an `Item` is associated to the `AddOn`, then the `avalara_transaction_type` must be absent.

  Constraints:

  • Minimum of 0.0
• addOnUpdateCode :: Maybe Text

  code: The unique identifier for the add-on within its plan. If an `Item` is associated to the `AddOn` then `code` must be absent.

  Constraints:

  • Maximum length of 50
• addOnUpdateCurrencies :: Maybe (NonEmpty AddOnPricing)

  currencies: If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then currencies must be absent. Must also be absent if `add_on_type` is `usage` and `usage_type` is `percentage`.

  Constraints:

  • Must have a minimum of 1 items
• addOnUpdateDefault_quantity :: Maybe Int

  default_quantity: Default quantity for the hosted pages.

• addOnUpdateDisplay_quantity :: Maybe Bool

  display_quantity: Determines if the quantity field is displayed on the hosted pages for the add-on.

• addOnUpdateId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• addOnUpdateLiability_gl_account_id :: Maybe Text

  liability_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• addOnUpdateMeasured_unit_id :: Maybe Text

  measured_unit_id: System-generated unique identifier for a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.

  Constraints:

  • Maximum length of 13
• addOnUpdateMeasured_unit_name :: Maybe Text

  measured_unit_name: Name of a measured unit to be associated with the add-on. Either `measured_unit_id` or `measured_unit_name` are required when `add_on_type` is `usage`. If `measured_unit_id` and `measured_unit_name` are both present, `measured_unit_id` will be used.

• addOnUpdateName :: Maybe Text

  name: Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.

  Constraints:

  • Maximum length of 255
• addOnUpdateOptional :: Maybe Bool

  optional: Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.

• addOnUpdatePercentage_tiers :: Maybe [PercentageTiersByCurrency]

  percentage_tiers: `percentage_tiers` is an array of objects, which must have the set of tiers per currency and the currency code. The tier_type must be `volume` or `tiered`, if not, it must be absent. There must be one tier without an `ending_amount` value which represents the final tier. This feature is currently in development and requires approval and enablement, please contact support.

• addOnUpdatePerformance_obligation_id :: Maybe Text

  performance_obligation_id: The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• addOnUpdateRevenue_gl_account_id :: Maybe Text

  revenue_gl_account_id: The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

  Constraints:

  • Maximum length of 13
• addOnUpdateRevenue_schedule_type :: Maybe AddOnUpdateRevenue_schedule_type

  revenue_schedule_type: When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.

• addOnUpdateTax_code :: Maybe Text

  tax_code: Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes. If an `Item` is associated to the `AddOn` then `tax_code` must be absent.

  Constraints:

  • Maximum length of 50
• addOnUpdateTiers :: Maybe [Tier]

  tiers: If the tier_type is `flat`, then `tiers` must be absent. The `tiers` object must include one to many tiers with `ending_quantity` and `unit_amount` for the desired `currencies`. There must be one tier without an `ending_quantity` value which represents the final tier.

• addOnUpdateUsage_calculation_type :: Maybe AddOnUpdateUsage_calculation_type

  usage_calculation_type: The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.

• addOnUpdateUsage_percentage :: Maybe Float

  usage_percentage: The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if `add_on_type` is usage, `tier_type` is `flat` and `usage_type` is percentage. Must be omitted otherwise.

Instances

FromJSON AddOnUpdate

Defined in RecurlyClient.Types.AddOnUpdate

Methods

parseJSON :: Value -> Parser AddOnUpdate

parseJSONList :: Value -> Parser [AddOnUpdate]

ToJSON AddOnUpdate

Defined in RecurlyClient.Types.AddOnUpdate

Methods

toJSON :: AddOnUpdate -> Value

toEncoding :: AddOnUpdate -> Encoding

toJSONList :: [AddOnUpdate] -> Value

toEncodingList :: [AddOnUpdate] -> Encoding

Show AddOnUpdate

Defined in RecurlyClient.Types.AddOnUpdate

Methods

showsPrec :: Int -> AddOnUpdate -> ShowS

show :: AddOnUpdate -> String

showList :: [AddOnUpdate] -> ShowS

Eq AddOnUpdate

Defined in RecurlyClient.Types.AddOnUpdate

Methods

(==) :: AddOnUpdate -> AddOnUpdate -> Bool

(/=) :: AddOnUpdate -> AddOnUpdate -> Bool

mkAddOnUpdate :: AddOnUpdate

Create a new AddOnUpdate with all required fields.

data AddOnUpdateRevenue_schedule_type

Defines the enum schema located at components.schemas.AddOnUpdate.properties.revenue_schedule_type in the specification.

When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.

Constructors

AddOnUpdateRevenue_schedule_typeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

AddOnUpdateRevenue_schedule_typeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

AddOnUpdateRevenue_schedule_typeEnumAt_range_end

Represents the JSON value "at_range_end"

AddOnUpdateRevenue_schedule_typeEnumAt_range_start

Represents the JSON value "at_range_start"

AddOnUpdateRevenue_schedule_typeEnumEvenly

Represents the JSON value "evenly"

AddOnUpdateRevenue_schedule_typeEnumNever

Represents the JSON value "never"

Instances

FromJSON AddOnUpdateRevenue_schedule_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

parseJSON :: Value -> Parser AddOnUpdateRevenue_schedule_type

parseJSONList :: Value -> Parser [AddOnUpdateRevenue_schedule_type]

ToJSON AddOnUpdateRevenue_schedule_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

toJSON :: AddOnUpdateRevenue_schedule_type -> Value

toEncoding :: AddOnUpdateRevenue_schedule_type -> Encoding

toJSONList :: [AddOnUpdateRevenue_schedule_type] -> Value

toEncodingList :: [AddOnUpdateRevenue_schedule_type] -> Encoding

Show AddOnUpdateRevenue_schedule_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

showsPrec :: Int -> AddOnUpdateRevenue_schedule_type -> ShowS

show :: AddOnUpdateRevenue_schedule_type -> String

showList :: [AddOnUpdateRevenue_schedule_type] -> ShowS

Eq AddOnUpdateRevenue_schedule_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

(==) :: AddOnUpdateRevenue_schedule_type -> AddOnUpdateRevenue_schedule_type -> Bool

(/=) :: AddOnUpdateRevenue_schedule_type -> AddOnUpdateRevenue_schedule_type -> Bool

data AddOnUpdateUsage_calculation_type

Defines the enum schema located at components.schemas.AddOnUpdate.properties.usage_calculation_type in the specification.

The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.

Constructors

AddOnUpdateUsage_calculation_typeOther Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

AddOnUpdateUsage_calculation_typeTyped Text

This constructor can be used to send values to the server which are not present in the specification yet.

AddOnUpdateUsage_calculation_typeEnumCumulative

Represents the JSON value "cumulative"

AddOnUpdateUsage_calculation_typeEnumLast_in_period

Represents the JSON value "last_in_period"

Instances

FromJSON AddOnUpdateUsage_calculation_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

parseJSON :: Value -> Parser AddOnUpdateUsage_calculation_type

parseJSONList :: Value -> Parser [AddOnUpdateUsage_calculation_type]

ToJSON AddOnUpdateUsage_calculation_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

toJSON :: AddOnUpdateUsage_calculation_type -> Value

toEncoding :: AddOnUpdateUsage_calculation_type -> Encoding

toJSONList :: [AddOnUpdateUsage_calculation_type] -> Value

toEncodingList :: [AddOnUpdateUsage_calculation_type] -> Encoding

Show AddOnUpdateUsage_calculation_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

showsPrec :: Int -> AddOnUpdateUsage_calculation_type -> ShowS

show :: AddOnUpdateUsage_calculation_type -> String

showList :: [AddOnUpdateUsage_calculation_type] -> ShowS

Eq AddOnUpdateUsage_calculation_type

Defined in RecurlyClient.Types.AddOnUpdate

Methods

(==) :: AddOnUpdateUsage_calculation_type -> AddOnUpdateUsage_calculation_type -> Bool

(/=) :: AddOnUpdateUsage_calculation_type -> AddOnUpdateUsage_calculation_type -> Bool