Documentation

Fields

• planCreateAccounting_code :: Maybe Text

  accounting_code: Accounting code for invoice line items for the plan. If no value is provided, it defaults to plan's code.

  Constraints:

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

  add_ons

• planCreateAllow_any_item_on_subscriptions :: Maybe Bool

  allow_any_item_on_subscriptions: Used to determine whether items can be assigned as add-ons to individual subscriptions. If `true`, items can be assigned as add-ons to individual subscription add-ons. If `false`, only plan add-ons can be used.

• planCreateAuto_renew :: Maybe Bool

  auto_renew: Subscriptions will automatically inherit this value once they are active. If `auto_renew` is `true`, then a subscription will automatically renew its term at renewal. If `auto_renew` is `false`, then a subscription will expire at the end of its term. `auto_renew` can be overridden on the subscription record itself.

• planCreateAvalara_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 plan is taxed. Refer to the documentation for more available t/s types.

  Constraints:

  • Minimum of 0.0
• planCreateAvalara_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 plan is taxed. Refer to the documentation for more available t/s types.

  Constraints:

  • Minimum of 0.0
• planCreateCode :: Text

  code: Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.

  Constraints:

  • Maximum length of 50
  • Must match pattern '/^[a-z0-9_+-]+$/i'
• planCreateCurrencies :: NonEmpty PlanPricing

  currencies

  Constraints:

  • Must have a minimum of 1 items
• planCreateCustom_fields :: Maybe CustomFields

  custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

• planCreateDescription :: Maybe Text

  description: Optional description, not displayed.

• planCreateDunning_campaign_id :: Maybe Text

  dunning_campaign_id: Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this plan. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

• planCreateHosted_pages :: Maybe PlanHostedPages

  hosted_pages

• planCreateInterval_length :: Maybe Int

  interval_length: Length of the plan's billing interval in `interval_unit`.

  Constraints:

  • Minimum of 1.0
• planCreateInterval_unit :: Maybe PlanCreateInterval_unit

  interval_unit: Unit for the plan's billing interval.

• planCreateLiability_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
• planCreateName :: Text

  name: This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.

  Constraints:

  • Maximum length of 255
• planCreatePerformance_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
• planCreatePricing_model :: Maybe PlanCreatePricing_model

  pricing_model: A fixed pricing model has the same price for each billing period. A ramp pricing model defines a set of Ramp Intervals, where a subscription changes price on a specified cadence of billing periods. The price change could be an increase or decrease.

• planCreateRamp_intervals :: Maybe [PlanRampInterval]

  ramp_intervals

• planCreateRevenue_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
• planCreateRevenue_schedule_type :: Maybe PlanCreateRevenue_schedule_type

  revenue_schedule_type

• planCreateSetup_fee_accounting_code :: Maybe Text

  setup_fee_accounting_code: Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.

  Constraints:

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

  setup_fee_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
• planCreateSetup_fee_performance_obligation_id :: Maybe Text

  setup_fee_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
• planCreateSetup_fee_revenue_gl_account_id :: Maybe Text

  setup_fee_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
• planCreateSetup_fee_revenue_schedule_type :: Maybe PlanCreateSetup_fee_revenue_schedule_type

  setup_fee_revenue_schedule_type

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

  Constraints:

  • Maximum length of 50
• planCreateTax_exempt :: Maybe Bool

  tax_exempt: `true` exempts tax on the plan, `false` applies tax on the plan.

• planCreateTotal_billing_cycles :: Maybe Int

  total_billing_cycles: Automatically terminate plans after a defined number of billing cycles.

  Constraints:

  • Minimum of 0.0
• planCreateTrial_length :: Maybe Int

  trial_length: Length of plan's trial period in `trial_units`. `0` means `no trial`.

  Constraints:

  • Minimum of 0.0
• planCreateTrial_requires_billing_info :: Maybe Bool

  trial_requires_billing_info: Allow free trial subscriptions to be created without billing info. Should not be used if billing info is needed for initial invoice due to existing uninvoiced charges or setup fee.

• planCreateTrial_unit :: Maybe PlanCreateTrial_unit

  trial_unit: Units for the plan's trial period.

• planCreateVertex_transaction_type :: Maybe Text

  vertex_transaction_type: Used by Vertex for tax calculations. Possible values are `sale`, `rental`, `lease`.