Update Settings

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
proration_modestringRequired

Optional: Proration calculation mode - daily|none

notify_on_signupstringRequired

Optional: Send notification on new signup - boolean 0|1

cancellation_modestringRequired

Optional: Cancellation mode - immediate|end_of_period

grace_period_daysstringRequired

Optional: Grace period after expiry in days - integer, min 0, max 365

membership_prefixstringRequired

Optional: Membership number prefix - string, max 20 chars - “MEM”

notify_on_renewalstringRequired

Optional: Send notification on renewal - boolean 0|1

first_billing_modestringRequired

Optional: First billing date mode - signup_date|first_of_month|first_of_next_month

allow_portal_signupstringRequired

Optional: Allow customer portal signup - boolean 0|1

price_change_policystringRequired

Optional: Price change policy - immediate|next_cycle|grandfathered

allow_prorate_refundstringRequired

Optional: Allow prorated refunds - boolean 0|1

auto_renewal_enabledstringRequired

Optional: Enable auto-renewal - boolean 0|1

renewal_reminder_daysstringRequired

Optional: Days before renewal to send reminder - integer, min 0, max 365

notify_on_cancellationstringRequired

Optional: Send notification on cancellation - boolean 0|1

allow_technician_signupstringRequired

Optional: Allow technicians to sign up customers - boolean 0|1

allow_portal_plan_changestringRequired

Optional: Allow customer portal plan change - boolean 0|1

membership_number_formatstringRequired

Optional: Number format template - string, max 100 chars

notify_on_expiry_warningstringRequired

Optional: Send notification on expiry warning - boolean 0|1

price_change_notice_daysstringRequired

Optional: Days notice before price change - integer, min 0, max 365

allow_portal_cancellationstringRequired

Optional: Allow customer portal cancellation - boolean 0|1

suspend_after_failed_daysstringRequired

Optional: Days after failed payment to auto-suspend - integer, min 0, max 365

Response

Successful response