SubscriptionAPILine

account_bundle object

idinteger

namestringrequired

account_bundle_idintegernullable

accounts object[]

Array [

idinteger

]

activeboolean

active_required_account_balance object

anyOf

• object
• NumRange

objectnullable

annual_feenumber

annual_fee_invoice_datedatenullable

annual_fee_on_invoiceboolean

annual_fee_service_item object

gl_accountstringnullable

idinteger

namestringrequired

contract object

idinteger

namestringrequired

contract_idintegernullable

createdbynullable

createddatedate-timenullable

divisional_billing_typenullable

divisions object[]

Array [

idinteger

]

effective_daterange object

anyOf

• object
• DateRange

objectnullable

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

member_communication_types object[]

Array [

descriptionstringrequired

idinteger

letter_type_idintegerrequired

namestringrequired

]

modifiedbynullable

modifieddatedate-timenullable

monthly_minimumnumber

monthly_minimum_on_invoiceboolean

monthly_minimum_service_item object

gl_accountstringnullable

idinteger

namestringrequired

namestringrequired

natural_languagestringnullable

no_division_filterboolean

note object

idinteger

textstringrequired

number_of_enrollmentsnumbernullable

paymentnumbernullable

payment_service_item object

gl_accountstringnullable

idinteger

namestringrequired

per_unitnumber

per_unit_on_invoiceboolean

per_unit_service_item object

gl_accountstringnullable

idinteger

namestringrequired

quantify_previous_billing_periodboolean

require_unit_for_monthly_minboolean

runout_required_account_balance object

anyOf

• object
• NumRange

objectnullable

subscription object

idinteger

term_required_account_balance object

anyOf

• object
• NumRange

objectnullable

tiered_per_unit_uuiduuidnullable

Default value: null

unitnullable

vendor_tenants object[]

Array [

idinteger

labelstringnullable

vendor object

codestringrequired

]

vendor_unit_calculation_methodnullable

vendor_unit_idintegernullable

vendor_unit_typenullable

vendor_unit_use_import_datebooleannullable

zero_total_on_invoiceboolean

SubscriptionAPILine

{
  "account_bundle": {
    "id": 0,
    "name": "string"
  },
  "account_bundle_id": 0,
  "accounts": [
    {
      "id": 0
    }
  ],
  "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": {
    "gl_account": "string",
    "id": 0,
    "name": "string"
  },
  "contract": {
    "id": 0,
    "name": "string"
  },
  "contract_id": 0,
  "createddate": "2024-07-29T15:51:28.071Z",
  "divisions": [
    {
      "id": 0
    }
  ],
  "effective_daterange": {},
  "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,
  "member_communication_types": [
    {
      "description": "string",
      "id": 0,
      "letter_type_id": 0,
      "name": "string"
    }
  ],
  "modifieddate": "2024-07-29T15:51:28.071Z",
  "monthly_minimum": 0,
  "monthly_minimum_on_invoice": true,
  "monthly_minimum_service_item": {
    "gl_account": "string",
    "id": 0,
    "name": "string"
  },
  "name": "string",
  "natural_language": "string",
  "no_division_filter": true,
  "note": {
    "id": 0,
    "text": "string"
  },
  "number_of_enrollments": 0,
  "payment": 0,
  "payment_service_item": {
    "gl_account": "string",
    "id": 0,
    "name": "string"
  },
  "per_unit": 0,
  "per_unit_on_invoice": true,
  "per_unit_service_item": {
    "gl_account": "string",
    "id": 0,
    "name": "string"
  },
  "quantify_previous_billing_period": true,
  "require_unit_for_monthly_min": true,
  "runout_required_account_balance": {},
  "subscription": {
    "id": 0
  },
  "term_required_account_balance": {},
  "tiered_per_unit_uuid": null,
  "vendor_tenants": [
    {
      "id": 0,
      "label": "string",
      "vendor": {
        "code": "string"
      }
    }
  ],
  "vendor_unit_id": 0,
  "vendor_unit_use_import_date": true,
  "zero_total_on_invoice": true
}