SubscriptionLine

account_bundle object

idinteger

namestringrequired

account_bundle_idintegernullable

account_category_bundle object

idinteger

namestringrequired

account_category_bundle_idintegernullable

account_category_groups object[]

Array [

idinteger

namestringrequired

]

account_renewal_groups object[]

Array [

account_renewal_group_idinteger

accounts object[]

Array [

namestringnullable

]

]

accounts object[]

Array [

account_renewal_group_idintegernullable

idinteger

namestringnullable

name_with_drstring

]

activeboolean

active_required_account_balance object

anyOf

• object
• NumRange

objectnullable

annual_feenumber

annual_fee_invoice_datedatenullable

annual_fee_on_invoiceboolean

annual_fee_service_item_idintegernullable

bill_to_contact object

bill_to_typenullable

billable_entity_id

idinteger

labelstringrequired

bill_to_contact_idintegernullable

commissions object[]

Array [

annual_feenumber

annual_fee_invoice_datedatenullable

effective_daterange object

anyOf

• object
• DateRange

objectnullable

fixednumbernullable

idinteger

parent_sales_entity object

idinteger

payout_typestring

Possible values: <= 19 characters, [always, minimum_required, under_min_flat_rate, under_min_percent]

pepmnumbernullable

(Per Employee Per Month) Amount to compensate commissioned entity for each line.

pepm_addonnumbernullable

(Per Employee Per Month Addon) Added charge to each line to compensate commissioned entity.

percentnumbernullable

sales_entity object

idinteger

namestringrequired

service_item_idintegernullable

show_annual_fee_on_invoiceboolean

show_fixed_on_invoicebooleanrequired

show_pepm_addon_on_invoicebooleanrequired

show_percent_on_invoicebooleanrequired

under_min_flat_ratenumbernullable

under_min_percentnumbernullable

]

contract object

idinteger

namestringrequired

contract_idintegernullable

divisional_billing_typenullable

divisions object[]

Array [

contact_idintegernullable

idinteger

namestringrequired

]

effective_daterange object

anyOf

• object
• DateRange

objectnullable

excluded_divisions object[]

Array [

idinteger

namestringrequired

]

grace_required_account_balance object

anyOf

• object
• NumRange

objectnullable

idinteger

include_account_namebooleannullable

include_active_membersboolean

include_grace_period_membersboolean

include_runout_membersboolean

include_term_runout_membersboolean

invoice_lines object[]

Array [

invoice object

invoice_keystringrequired

]

member_communication_types object[]

Array [

descriptionstringrequired

idinteger

letter_type_idintegerrequired

namestringrequired

]

monthly_minimumnumber

monthly_minimum_on_invoiceboolean

monthly_minimum_service_item_idintegernullable

namestringrequired

natural_languagestringnullable

no_division_filterboolean

note object

textstringrequired

number_of_enrollmentsnumbernullable

paymentnumbernullable

payment_service_item_idintegernullable

per_unitnumber

per_unit_on_invoiceboolean

per_unit_service_item_idintegernullable

quantify_previous_billing_periodboolean

recurringboolean

require_unit_for_monthly_minboolean

runout_required_account_balance object

anyOf

• object
• NumRange

objectnullable

term_required_account_balance object

anyOf

• object
• NumRange

objectnullable

unitnullable

vendor_unitnullable

vendor_unit_calculation_methodnullable

vendor_unit_idintegernullable

vendor_unit_typenullable

vendor_unit_use_import_datebooleannullable

zero_total_on_invoiceboolean

SubscriptionLine

{
  "account_bundle": {
    "id": 0,
    "name": "string"
  },
  "account_bundle_id": 0,
  "account_category_bundle": {
    "id": 0,
    "name": "string"
  },
  "account_category_bundle_id": 0,
  "account_category_groups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "account_renewal_groups": [
    {
      "account_renewal_group_id": 0,
      "accounts": [
        {
          "name": "string"
        }
      ]
    }
  ],
  "accounts": [
    {
      "account_renewal_group_id": 0,
      "id": 0,
      "name": "string",
      "name_with_dr": "string"
    }
  ],
  "active": true,
  "active_required_account_balance": {},
  "annual_fee": 0,
  "annual_fee_invoice_date": "2024-07-29",
  "annual_fee_on_invoice": true,
  "annual_fee_service_item_id": 0,
  "bill_to_contact": {
    "id": 0,
    "label": "string"
  },
  "bill_to_contact_id": 0,
  "commissions": [
    {
      "annual_fee": 0,
      "annual_fee_invoice_date": "2024-07-29",
      "effective_daterange": {},
      "fixed": 0,
      "id": 0,
      "parent_sales_entity": {
        "id": 0
      },
      "pepm": 0,
      "pepm_addon": 0,
      "percent": 0,
      "sales_entity": {
        "id": 0,
        "name": "string"
      },
      "service_item_id": 0,
      "show_annual_fee_on_invoice": true,
      "show_fixed_on_invoice": true,
      "show_pepm_addon_on_invoice": true,
      "show_percent_on_invoice": true,
      "under_min_flat_rate": 0,
      "under_min_percent": 0
    }
  ],
  "contract": {
    "id": 0,
    "name": "string"
  },
  "contract_id": 0,
  "divisions": [
    {
      "contact_id": 0,
      "id": 0,
      "name": "string"
    }
  ],
  "effective_daterange": {},
  "excluded_divisions": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "grace_required_account_balance": {},
  "id": 0,
  "include_account_name": true,
  "include_active_members": true,
  "include_grace_period_members": true,
  "include_runout_members": true,
  "include_term_runout_members": true,
  "invoice_lines": [
    {
      "invoice": {
        "invoice_key": "string"
      }
    }
  ],
  "member_communication_types": [
    {
      "description": "string",
      "id": 0,
      "letter_type_id": 0,
      "name": "string"
    }
  ],
  "monthly_minimum": 0,
  "monthly_minimum_on_invoice": true,
  "monthly_minimum_service_item_id": 0,
  "name": "string",
  "natural_language": "string",
  "no_division_filter": true,
  "note": {
    "text": "string"
  },
  "number_of_enrollments": 0,
  "payment": 0,
  "payment_service_item_id": 0,
  "per_unit": 0,
  "per_unit_on_invoice": true,
  "per_unit_service_item_id": 0,
  "quantify_previous_billing_period": true,
  "recurring": true,
  "require_unit_for_monthly_min": true,
  "runout_required_account_balance": {},
  "term_required_account_balance": {},
  "vendor_unit_id": 0,
  "vendor_unit_use_import_date": true,
  "zero_total_on_invoice": true
}