Documentation

Fields

• addOnAccounting_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.

  Constraints:

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

  add_on_type: Whether the add-on type is fixed, or usage-based.

• addOnAvalara_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.

  Constraints:

  • Minimum of 0.0
• addOnAvalara_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.

  Constraints:

  • Minimum of 0.0
• addOnCode :: Text

  code: The unique identifier for the add-on within its plan.

  Constraints:

  • Maximum length of 50
• addOnCreated_at :: Maybe JsonDateTime

  created_at

• addOnCurrencies :: Maybe (NonEmpty AddOnPricing)

  currencies

  Constraints:

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

  default_quantity: Default quantity for the hosted pages.

• addOnDeleted_at :: Maybe JsonDateTime

  deleted_at

• addOnDisplay_quantity :: Maybe Bool

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

• addOnExternal_sku :: Maybe Text

  external_sku: Optional, stock keeping unit to link the item to other inventory systems.

  Constraints:

  • Maximum length of 50
• addOnId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• addOnItem :: Maybe ItemMini

  item: Just the important parts.

• addOnLiability_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
• addOnMeasured_unit_id :: Maybe Text

  measured_unit_id: System-generated unique identifier for an measured unit associated with the add-on.

  Constraints:

  • Maximum length of 13
• addOnName :: Text

  name: Describes your add-on and will appear in subscribers' invoices.

  Constraints:

  • Maximum length of 255
• addOnObject :: Maybe Text

  object

• addOnOptional :: 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.

• addOnPercentage_tiers :: Maybe [PercentageTiersByCurrency]

  percentage_tiers: This feature is currently in development and requires approval and enablement, please contact support.

• addOnPerformance_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
• addOnPlan_id :: Maybe Text

  plan_id

  Constraints:

  • Maximum length of 13
• addOnRevenue_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
• addOnRevenue_schedule_type :: Maybe AddOnRevenue_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.

• addOnState :: Maybe AddOnState

  state: Add-ons can be either active or inactive.

• addOnTax_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 `item_code`/`item_id` is part of the request then `tax_code` must be absent.

  Constraints:

  • Maximum length of 50
• addOnTier_type :: Maybe AddOnTier_type

  tier_type: The pricing model for the add-on. For more information, click here. See our Guide for an overview of how to configure quantity-based pricing models.

• addOnTiers :: Maybe [Tier]

  tiers

• addOnUpdated_at :: Maybe JsonDateTime

  updated_at

• addOnUsage_calculation_type :: Maybe AddOnUsage_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.

• addOnUsage_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.

• addOnUsage_timeframe :: Maybe AddOnUsage_timeframe

  usage_timeframe: The time at which usage totals are reset for billing purposes.

• addOnUsage_type :: Maybe AddOnUsage_type

  usage_type: Type of usage, returns usage type if `add_on_type` is `usage`.