Billing period definitions indicate the date of when to invoice the associated subscriptions for the related customer. These rely heavily on the customer and account billing period configuration.
Some additional information about how billing periods are managed through the Admin UI are available in the support documentation:
Default billing period configuration
Manage customer billing periods
Billing Period Definition Object Fields
| Property | Type | Description |
|---|---|---|
currentBillingPeriodStartDate | DateTime | The timestamp of when the current billing period began. |
currentBillingPeriodEndDate | DateTime | The timestamp of when the current billing period will end. |
nextRechargeDate | DateTime | The scheduled time of recharge. |
invoiceDay | Integer | The day of the month to bill on |
invoiceMonth | Integer | Indicates the month of the year to cycle on. Typically only used for yearly cycle. If this parameter is used for a monthly cycle, that means Fusebill will adjust the billing period such that the recharge occurs on the provided day and month. |
cycle | Enum: {Monthly, Yearly} | These are the units of measurement used for numberOfIntervals which in turn defines a period. |
billingPeriodType | Enum: {CustomerActivation,FirstSubscriptionActivation, SpecifiedDate} | Dictates what model of billing period is being defined |
createdDate | DateTime | The timestamp of when this billing period definition was created. [Read Only] |
numberOfIntervals | Integer | How many units of the cycle define a period. |
numberOfBillingPeriods | Number | The number of billing periods associated with this definition. This includes open, closed, and projected periods |
invoiceInAdvance | Number | The number of days in advance this billing period definition will invoice. Relevant only for accounts which use the invoice in advance feature. |
manuallyCreated | Boolean | Indicates whether this definition was made explicitly, or as a side effect of subscription creation. |
paymentMethodId | Number | A billing period definition can have a specific payment method associated with it. If so, then this is the Fusebill generated ID of the payment method. This is an override, so NULL means to use the customer default method. This is relevant only for automatic collection. |
autoCollect | Boolean | A billing period definition can override whether its resulting invoices are eligible for automatic collection attempts. Since this is an override, NULL means to use the customer's default setting. |
autoPost | Boolean | A billing period definition can override whether its generated invoices should be posted, or remain in ready draft. Since this is an override, NULL means to use the customer's default setting. |
term | Enum:{Net0, Net5, Net7, Net10, Net15, Net21, Net30, Net45, Net60, Net75, Net90, MFI1, DayOfMonth1, DayOfMonth2, DayOfMonth3, ... DayOfMonth29, DayOfMonth30, DayOfMonth31} | A billing period definition can override what the billing term will be on its resulting invoices. Since this is an override, NULL or the empty string means to use the customer's default setting. |
poNumber | String [Max Length: 255 characters] | A billing period definition can override what the PO number will be on its resulting invoices. Since this is an override, NULL or the empty string means to use the customer's default setting. |
subscriptions | Object | Contains a field called results which lists summarized subscription objects for subscriptions associated with this billing period definition. See Subscriptions: Subscription Object for details |
id | Integer | The Fusebill generated ID that uniquely identifies this Billing Period Definition [Read Only] |
uri | String | The full string path to this resource [Read Only] |