Skip to main content

SubscriptionAPILineWrite

account_bundle_idintegernullable
account_category_bundle_idintegernullable
account_idsinteger[]
activeboolean
active_required_account_balance object
anyOf
objectnullable
annual_feenumber
annual_fee_invoice_datedatenullable
annual_fee_on_invoiceboolean
annual_fee_service_item_idintegernullable
bill_to_contact_idintegernullable
contract_idintegernullable
division_idsinteger[]
divisional_billing_typenullable
effective_daterange object
anyOf
objectnullable
grace_required_account_balance object
anyOf
objectnullable
include_account_namebooleannullable
include_active_membersboolean
include_grace_period_membersboolean
include_runout_membersboolean
include_term_runout_membersboolean
member_communication_type_idsinteger[]
monthly_minimumnumber
monthly_minimum_on_invoiceboolean
monthly_minimum_service_item_idintegernullable
namestringrequired
no_division_filterboolean
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
objectnullable
subscription_line_bundle_idintegernullable
term_required_account_balance object
anyOf
objectnullable
tiered_per_unit_uuiduuidnullable
Default value: null
unitnullable
vendor_unit_calculation_methodnullable
vendor_unit_idintegernullable
vendor_unit_typenullable
vendor_unit_use_import_datebooleannullable
zero_total_on_invoiceboolean
SubscriptionAPILineWrite
{
"account_bundle_id": 0,
"account_category_bundle_id": 0,
"account_ids": [
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_id": 0,
"bill_to_contact_id": 0,
"contract_id": 0,
"division_ids": [
0
],
"effective_daterange": {},
"grace_required_account_balance": {},
"include_account_name": true,
"include_active_members": true,
"include_grace_period_members": true,
"include_runout_members": true,
"include_term_runout_members": true,
"member_communication_type_ids": [
0
],
"monthly_minimum": 0,
"monthly_minimum_on_invoice": true,
"monthly_minimum_service_item_id": 0,
"name": "string",
"no_division_filter": true,
"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": {},
"subscription_line_bundle_id": 0,
"term_required_account_balance": {},
"tiered_per_unit_uuid": null,
"vendor_unit_id": 0,
"vendor_unit_use_import_date": true,
"zero_total_on_invoice": true
}