SubscriptionLineSchema

_divisionsundefined[]

account_bundle_idintegernullable

account_category_bundle_idintegernullable

activeboolean

active_per_unitnumbernullable

annual_feenumber

annual_fee_invoice_datedatenullable

annual_fee_on_invoiceboolean

annual_fee_service_item_idintegernullable

bill_to

bill_to_contact_idintegernullable

bill_to_typenullable

contract_idintegernullable

createdbynullable

createdby_idintegernullable

createddatedate-timenullable

divisional_billing_typenullable

generate_bills_from_flat_rateboolean

If True, this billing line will generate bills from the flat rates on the vendor unit. If False, it will generate bills from the rate table. Defaults to False.

grace_per_unitnumbernullable

has_invoice_linesboolean

idinteger

ignore_hire_term_dateboolean

include_account_namebooleannullable

include_active_membersboolean

include_grace_period_membersboolean

include_runout_membersboolean

include_term_runout_membersboolean

modifiedbynullable

modifiedby_idintegernullable

modifieddatedate-timenullable

monthly_minimumnumber

monthly_minimum_on_invoiceboolean

monthly_minimum_service_item_idintegernullable

namestringrequired

natural_languagestringnullable

no_division_filterboolean

note_idintegernullable

number_of_enrollmentsnumbernullable

paymentnumbernullable

payment_service_item_idintegernullable

per_unitnumber

per_unit_on_invoiceboolean

per_unit_service_item_idintegernullable

quantify_previous_billing_periodboolean

rate_table_rowsundefined[]

recurringboolean

require_unit_for_monthly_minboolean

runout_per_unitnumbernullable

subscription_idintegerrequired

subscription_line_bundle_idintegernullable

term_per_unitnumbernullable

term_supersedes_prior_runoutboolean

If True, a member who is in term runout state on a newer plan year's account (within the same accounts_in_same_group_for_dr grouping) is excluded from the runout state on older plan years' accounts for the same member. Defaults to False, which preserves existing behavior (no cross-plan-year suppression between runout and term runout).

tiered_per_unit_uuiduuidnullable

Default value: null

tpafilesundefined[]

unitnullable

vendor_subscription_linesundefined[]

vendor_unitnullable

vendor_unit_calculation_methodnullable

vendor_unit_idintegernullable

vendor_unit_typenullable

vendor_unit_use_import_datebooleannullable

zero_total_on_invoiceboolean

SubscriptionLineSchema

{
  "_divisions": [
    null
  ],
  "account_bundle_id": 0,
  "account_category_bundle_id": 0,
  "active": true,
  "active_per_unit": 0,
  "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,
  "contract_id": 0,
  "createdby_id": 0,
  "createddate": "2024-07-29T15:51:28.071Z",
  "generate_bills_from_flat_rate": true,
  "grace_per_unit": 0,
  "has_invoice_lines": true,
  "id": 0,
  "ignore_hire_term_date": true,
  "include_account_name": true,
  "include_active_members": true,
  "include_grace_period_members": true,
  "include_runout_members": true,
  "include_term_runout_members": true,
  "modifiedby_id": 0,
  "modifieddate": "2024-07-29T15:51:28.071Z",
  "monthly_minimum": 0,
  "monthly_minimum_on_invoice": true,
  "monthly_minimum_service_item_id": 0,
  "name": "string",
  "natural_language": "string",
  "no_division_filter": true,
  "note_id": 0,
  "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,
  "rate_table_rows": [
    null
  ],
  "recurring": true,
  "require_unit_for_monthly_min": true,
  "runout_per_unit": 0,
  "subscription_id": 0,
  "subscription_line_bundle_id": 0,
  "term_per_unit": 0,
  "term_supersedes_prior_runout": true,
  "tiered_per_unit_uuid": null,
  "tpafiles": [
    null
  ],
  "vendor_subscription_lines": [
    null
  ],
  "vendor_unit_id": 0,
  "vendor_unit_use_import_date": true,
  "zero_total_on_invoice": true
}