Update Customer Billing Settings

put

https://secure.fusebill.com/v1/customers/{CustomerId}/billingsettings

Override the default customer billing settings for a specific customer. Recommended Request: It is recommended that the invoiceDay field either be omitted or the value set to null for the PUT method. Use Read Customer Billing Settings to get a starting payload to modify.

Request Parameters

Property	Type	Description
`id`	Integer	Unique customer ID for the billing settings you want to update.
`invoiceDay`	`null`	Deprecated. Omit this field or set it to `null` for `PUT` requests.
`term`	Enum: `{Net0, Net5, Net7, Net10, Net15, Net21, Net30, Net45, Net60, Net75, Net90, MFI1, DayOfMonth1, DayOfMonth2, DayOfMonth3, ... DayOfMonth29, DayOfMonth30, DayOfMonth31}`	Defines the payment terms for this customer.
`interval`	`null`	Deprecated. Omit this field or set it to `null` for `PUT` requests.
`autoCollect`	Boolean or `null`	Controls whether the billing system attempts to collect from the customer’s payment method on file. `null` uses the account-level default.
`autoCollectSettingType`	Enum: `{CurrentInvoice, OutstandingBalance, Threshold}`	Defines the auto-collect behavior when `autoCollect` is enabled.
`dunningExempt`	Boolean	Controls whether this customer is exempt from your account’s dunning management settings.
`rechargeType`	String	Set this to `BringBalanceBackTo` when using threshold billing.
`rechargeThresholdAmount`	Integer	Amount that triggers a threshold collection when the customer balance drops below this value.
`rechargeTargetAmount`	Currency	Target balance to restore when threshold billing is triggered.
`statusOnThreshold`	Boolean	Controls whether the customer enters poor standing if the threshold recharge payment fails.
`autoPostDraftInvoice`	Boolean or `null`	Controls whether draft invoices are automatically posted for this customer. `null` uses the account-level default.
`customerGracePeriod`	Integer	Number of days the customer can remain in poor standing before the account is suspended.
`gracePeriodExtension`	Integer	Additional number of days added to the customer’s grace period.
`customerAutoCancel`	Integer	Number of days after suspension before the customer is automatically cancelled.
`defaultCancelOption`	Enum: `{Full, None, Unearned}`	Controls revenue recognition if the customer is automatically cancelled.
`standingPoNumber`	String	PO number added to this customer’s invoices.
`billingPeriodConfigurations`	Array of objects	Billing period configuration overrides for this customer. See Billing Period Configuration Object Fields.
`acquisitionCost`	Decimal	Cost in dollars spent to acquire this customer.
`showZeroDollarCharges`	Boolean or `null`	Controls whether `$0` charges appear on this customer’s invoices. `null` uses the account-level default.
`taxExempt`	Boolean	Controls whether this customer is charged taxes.
`taxExemptCode`	String	Tax exemption code for this customer. Required if `taxExempt` is `true`.
`useCustomerBillingAddress`	Boolean or `null`	Controls whether billing or shipping address is used for taxation. `null` uses the account-level default.
`avalaraUsageType`	String	String sent to Avalara to determine how sales taxes are applied.
`vatIdentificationNumber`	Integer	Customer’s EU VAT identification number.
`customerServiceStartOption`	String	Controls how the system behaves if a suspended customer is returned to active status after successful auto-collection.
`rollUpTaxes`	Boolean	Controls whether taxes appear as one rolled-up line or as separate tax lines on invoices.
`rollUpDiscounts`	Boolean	Controls whether discounts are rolled up into a single invoice line item.
`rollUpPdfsByPlanProduct`	Boolean	Controls whether downloaded invoices show summarized or detailed subscription product charges.
`invoiceSummarization`	Boolean	Controls invoice summarization behavior for this customer.
`invoiceSummarizationOption`	String	Invoice summarization option value for this customer.
`rollUpPdfsDisplayName`	Boolean	Controls whether plan names are displayed on summarized invoices.
`rollUpPdfsDisplayDescription`	Boolean	Controls whether plan descriptions are displayed on summarized invoices.
`rollUpPdfsDisplayAllUnitPrices`	Boolean	Controls whether all unit prices are displayed on summarized invoices.
`pdfInvoiceEmailAttachmentOption`	Enum: `{Details, Summary, Both}`	Controls how subscription charges are displayed on emailed invoices.
`invoiceSummarizationFollowAccountDefaults`	Boolean	Controls whether invoice summarization follows the account-level default.
`trackedItemDisplay`	Object	Controls how tracked items appear on invoices for this customer. See Tracked Item Display Object Fields.
`customerBillingStatementSetting`	Object	Controls billing statement settings for this customer. See Customer Billing Statement Setting Object Fields.
`postReadyChargesOnRenew`	Boolean or `null`	Controls whether ready draft charges are posted on renewal. `null` uses the account-level default.
`autoAllocateToOverdueInvoices`	Boolean or `null`	Controls whether unallocated funds on the customer's account are automatically applied to overdue invoices. `null` uses the account-level default.
`HierarchySuspendOption`	String	Hierarchy suspension option for this customer.
`selfServicePortalCreditCard`	Boolean or `null`	Controls whether this customer can add a credit card in the self-service portal. `null` uses the account-level default.
`selfServicePortalACH`	Boolean or `null`	Controls whether this customer can add an ACH payment method in the self-service portal. `null` uses the account-level default.
`autoAllocateToOverdueInvoices`	Boolean or `null`	Controls whether unallocated funds on the customer's account are automatically applied to overdue invoices. `null` uses the account-level default.

Billing Period Configuration Object Fields

Property	Type	Description
`type`	Enum:{SpecifiedDate, CustomerActivation, FirstSubscriptionActivation}	Controls when subscriptions of the configured interval are recharged
`rule`	Enum:{SingleInvoice, MultipleInvoices, OneInvoicePerDay, Prompt}	Controls how to invoice. Single Invoice compiles subscriptions of the given interval on one invoice. Multiple Invoices separates them as one invoice per subscription. One Invoice Per Day posts an invoice every day. Prompt requires an agent to approve it each time.
`interval`	Enum:{Yearly, Monthly}	Indicates which type of billing period this configuration applies to.
`day`	Integer (1-31)	The day of the month to recharge. Use only if `type` is "SpecifiedDate"
`month`	Integer (1-12)	The month of the year to recharge. Use only if `type` is "SpecifiedDate" and `interval` is "Yearly"

Tracked Item Display Object Fields

Property	Type	Description
`trackedItemDisplayFormat`	Enum:{Inline, SeperatePage}	Controls where the tracked items are displayed.
`showTrackedItemName`	Boolean	This controls if the tracked items names are displayed.
`showTrackedItemReference`	Boolean	This controls if the tracked items' reference are displayed.
`showTrackedItemDescription`	Boolean	This controls if the tracked items' description are displayed.
`showTrackedItemCreatedDate`	Boolean	This controls if tracked items' created dates are displayed.

Customer Billing Statement Setting Object Fields

Property	Type	Description
`option`	Enum:{Detailed, BySubscription, Summarized}	Controls how the statement is generated.
`type`	Enum:{CustomerAnniversary, SpecifiedDate}	The basis for when statements are generated
`interval`	Enum:{Monthly, Yearly}	Controls frequency of statement generation.
`day`	Integer	The day of the month to generate the statement if `type` is "SpecifiedDate"
`month`	Integer	The month of the year to generate the statement if `type` is "SpecifiedDate" and `interval` is "Yearly".
`trackedItemDisplay`	Object (defined above)	Controls how tracked items are displayed on the statement.
`statementActivityType`	Enum: {OnlyParentActivity, OnlyChildActivity, ParentAndChildActivity}	Controls which activities to generate if customer hierarchy is being used.

Path Params

CustomerId

int32

required

Unique id of the customer object.

Body Params

int32

required

Unique id of the customer object.

invoiceDay

string

enum

Deprecated field. Set/keep this as null or do not include it in payload.

Allowed:

term

string

enum

This defines the Payment Terms for this Customer.

Allowed:

interval

string

enum

Deprecated field. Set/keep this as null or do not include it in payload.

Allowed:

autoCollect

boolean

This defines whether the billing system will attempt to collect from the customer's payment method on file. The global auto collect setting is used by default and by setting this field explicitly on the Customer the setting can be overridden for this Customer. This setting can only be explicitly set to True if the customer has a Payment Method, such as a credit card of ACH account, on file. If set to true then when charges are applied to the Customer the billing system will attempt to collect them in full form the default payment method on file. If set to false the billing system will not collect automatically. If set to null then the billing system will use the global auto collect setting.

autoCollectSettingType

string

enum

When auto collect is set to on, this defines the type of auto collect. CurrentInvoice, OutstandingBalance, or Threshold are acceptable valid strings that can be used to set auto collect behaviour.

Allowed:

dunningExempt

boolean

Controls whether this customer is exempt from your account's Dunning management settings. Dunning management settings control how and when Fusebill will automatically try to collect the outstanding balance of customers in poor standing. Relevant only for customers subject to auto collect.

rechargeType

string

enum

Only set this to BringBalanceBackTo when setting autoCollectSettingType to Threshold

Allowed:

rechargeThresholdAmount

float

This is the value which triggers a threshold collection. If the customer balance drops below this number when an invoice is posted the system will automatically collect enough funds to bring the balance back to the rechargeTargetAmount.

statusOnThreshold

boolean

This setting determines if the customer should enter poor standing if their balance dips below the set threshold and the payment to restore the balance fails.

autoPostDraftInvoice

boolean

This defines whether the billing system will attempt to automatically post draft Invoices against the Customer's account. The global autoPostDraftInvoice setting is used by default and by setting this field explicitly on the Customer the setting can be overridden for this Customer. If set to true then when an Invoice is generated in Draft status the Invoice will be automatically converted to a Posted invoice and the charges from the Invoice will be applied to the Customer. If set to false the billing system will not post the Invoices automatically. If set to NULL then the billing system will use the global autoPostDraftInvoice setting.

customerGracePeriod

int32

This filed defines the number of days that the Customer is allowed to be in a PoorStanding status before the system will automatically place the Customer account in a Suspended state. Customer's enter PoorStanding when one or more Invoices go unpaid and enter an Overdue status.

gracePeriodExtension

int32

customerAutoCancel

int32

The number of days after suspension before the customer is cancelled by the system.

defaultCancelOption

string

enum

Controls revenue recognition in the event of customer automatic cancellation. "Full" means to reverse all charges fully. "None" means earn all charges. "Unearned" means to reverse unearned amounts for all charges. NULL means to follow the default of the Stax Bill account.

Allowed:

standingPoNumber

string

billingPeriodConfigurations

array

billingPeriodConfigurations

acquisitionCost

float

showZeroDollarCharges

boolean

taxExempt

boolean

taxExemptCode

string

useCustomerBillingAddress

boolean

avalaraUsageType

string

vatIdentificationNumber

string

customerServiceStartOption

string

rollUpTaxes

boolean

rollUpDiscounts

boolean

invoiceSummarization

boolean

invoiceSummarizationOption

string

rollUpPdfsDisplayName

boolean

rollUpPdfsDisplayDescription

boolean

rollUpPdfsDisplayAllUnitPrices

boolean

pdfInvoiceEmailAttachmentOption

string

invoiceSummarizationFollowAccountDefaults

boolean

trackedItemDisplay

object

postReadyChargesOnRenew

boolean

HierarchySuspendOption

string

selfServicePortalCreditCard

boolean

enum

Effectively adds or removes customer ability to add their own credit card through the hosted self-service portal. Overrides the self-service portal setting for displaying input fields to allow a customer to add a credit card payment method through the self-service portal.
A null value (default) will use the portal settings default.
A true value will always show the credit card inputs from the customer in the self-service portal.
A false value will always hide the credit card inputs from the customer in the self-service portal.

Allowed:

selfServicePortalACH

boolean

enum

Effectively adds or removes customer ability to add their own ACH/EFT (bank account) payment method through the hosted self-service portal.
Overrides the self-service portal setting for displaying input fields to allow a customer to add an ACH payment method through the self-service portal.
A null value (default) will use the portal settings default.
A true value will always show the ACH inputs from the customer in the self-service portal.
A false value will always hide the ACH inputs from the customer in the self-service portal.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

Request Parameters

Billing Period Configuration Object Fields

Tracked Item Display Object Fields

Customer Billing Statement Setting Object Fields

200200

400400