BillingSchedule
Stores the order item information used in the invoicing process.
When you activate an order, Subscription Management creates one billing schedule for each order item in an order. For example, if an order contains 15 order items, Subscription Management creates 15 billing schedules, one billing schedule for each item. The invoice scheduler uses the information in the billing schedule to determine when it’s time to invoice an order item.
Billing schedules for all order items that are generated from one asset are summarized in a billing schedule group.
Introduced in API version 55.0.
describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()
- This object is available with Subscription Management and Billing (Revenue Cloud).
- For information about this object that’s available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort
- Description: An integer from 1 to 31 that indicates the day of the month.
-
Type: currency
-
Properties: Filter, Nillable, Sort
-
Description:
The total amount (excluding tax) that has been invoiced from the billing schedule.
This field is a calculated field.
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Description: The last billing period that includes this date.
- Type: reference
- Properties: Filter, Group, Sort
- Description: This field is a relationship field.
- Relationship name: BillingAccount
- Relationship type: relationship
- Refers to: Account
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 63.0
-
Relationship name: BillingMilestonePlan
-
Relationship type: relationship
-
Refers to: BillingMilestonePlan
-
Type: currency
-
Properties: Filter, Nillable, Sort
-
Description:
The amount to be invoiced each billing period.
For example, if the billing period is monthly, this field shows the monthly amount that appears on the invoice line.
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort
- Description: The last date that the billing schedule is available for invoicing. Inherited from the EndDate field on the order item.
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Description:
ID of the billing schedule group that contains the billing schedule. Billing schedules are grouped when they have the same source order item. The source order item is the original order item that a customer bought. Afterwards, if the customer amends, cancels, or renews the order item, a new billing schedule is created with the BillingScheduleGroupId for the original order item.
This field is a relationship field.
-
Relationship name: BillingScheduleGroup
-
Relationship type: masterdetail
-
Refers to: BillingScheduleGroup
- Type: string
- Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
- Description: Autogenerated reference number for the billing schedule.
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort
- Description: The date that the billing schedule is available for invoicing. Inherited from the ServiceDate on the order item.
- Type: int
- Properties: Filter, Group, Nillable, Sort
- Type: picklist
- Properties: Filter, Group, Restricted picklist, Sort
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 67.0
-
Relationship name: BillingTreatment
-
Relationship type: relationship
-
Refers to: BillingTreatment
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort
-
Introduced: API version 55.0
-
Description:
The billing treatment item used to configure invoiceable amounts on the billing schedule.
This field is a relationship field.
-
Relationship name: BillingTreatmentItem
-
Relationship type: relationship
-
Refers to: BillingTreatmentItem
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort, Update
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 55.0
-
Type: date
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 53.0
-
Description:
The date on which the subscriber can no longer access the service. For example, if a service ends on August 31, then the cancellation date is September 1, because that’s the date when the subscriber can no longer use the service.
Subscription Management doesn’t invoice billing schedules past their cancellation date.
-
Type: picklist
-
Properties: Create, Filter, Group, Restricted picklist, Sort
-
Description:
The business action represented by the billing schedule.
Possible values are:
- AmendQuantity—A billing schedule for an order that changes the quantity. This object is available in API version 56.0 and later.
- Cancellation—A billing schedule for an order that was canceled
- Original—A billing schedule for the initial order
- Renewal—A billing schedule for an order that was renewed
-
Possible values:
- AmendQuantity — AmendQuantity
- Cancellation — Cancellation
- Original — Original
- Renewal — Renewal
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 62.0
- Type: string
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 60.0
- Type: string
- Properties: Filter, Group, idLookup, Nillable, Sort
- Introduced: API version 60.0
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 68.0
-
Relationship name: ForecastBatchRun
-
Relationship type: relationship
-
Refers to: InvoiceBatchRun
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 68.0
- Type: string
- Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
- Introduced: API version 52.0
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 65.0
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 60.0
-
Relationship name: InvBatchDraftToPostedRun
-
Relationship type: relationship
-
Refers to: InvBatchDraftToPostedRun
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort, Update
-
Introduced: API version 55.0
-
Description:
The invoice batch run that evaluated this billing schedule and its billing period items to produce an invoice.
This field is a relationship field.
-
Relationship name: InvoiceBatchRun
-
Relationship type: relationship
-
Refers to: InvoiceBatchRun
- Type: picklist
- Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 62.0
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 55.0
-
Type: boolean
-
Properties: Defaulted on create, Filter, Group, Sort
-
Introduced: API version 65.0
-
Default value: false
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Introduced: API version 68.0
- Type: currency
- Properties: Create, Filter, Nillable, Sort
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
- Type: currency
- Properties: Filter, Nillable, Sort
- Introduced: API version 64.0
- Type: date
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The date that the next billing period starts for the invoice. Used to calculate which invoice lines are included on an invoice. When an invoice scheduler or API evaluates an order for invoicing, billing schedules with a next billing date on or before the invoice’s target date are included on the invoice.
- Type: date
- Properties: Filter, Group, Nillable, Sort
- Description: The date that the billing schedule is invoiced in the upcoming billing period. For example, if you invoiced a customer for a billing period of 01/01/22 through 01/31/22, the billing schedule’s
NextChargeFromDateis 02/01/22.
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Introduced: API version 53.0
-
Description:
If this billing schedule is an amended or canceled billing schedule, then this field shows the original billing schedule. Otherwise, this field is null.
This field is a relationship field.
-
Relationship name: OriginalBillingSchedule
-
Relationship type: relationship
-
Refers to: BillingSchedule
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The amount from the current billing term that hasn’t been billed yet. For example, the unbilled amount for a month, quarter, or year, depending on this billing schedule’s billing term.
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Introduced: API version 66.0
- Type: double
- Properties: Filter, Nillable, Sort
- Type: double
- Properties: Create, Filter, Nillable, Sort
- Description: The quantity of the order item that created the billing schedule.
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 68.0
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort
- Introduced: API version 61.0
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
The parent order of the order item that created the billing schedule.
This field is a polymorphic relationship field.
-
Relationship name: ReferenceEntity
-
Relationship type: polymorphic
-
Refers to: InsurancePolicyTransaction, Order, OrderSummary, Quote
-
Type: reference
-
Properties: Filter, Group, Nillable, Sort
-
Description:
The order item or asset that created the billing schedule.
This field is a polymorphic relationship field.
-
Relationship name: ReferenceEntityItem
-
Relationship type: polymorphic
-
Refers to: DebitMemoLine, InsPolicyTransactionDetail, InsurancePolicyTransaction, OrderItem, OrderItemAdjustmentLineItem, OrderItemDetail, OrderItemSummary, QuoteLineDetail, QuoteLineItem, RegulatoryTrxnFeeItem
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort
- Introduced: API version 61.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 68.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 68.0
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 68.0
- Type: picklist
- Properties: Create, Filter, Group, Restricted picklist, Sort, Update
- Introduced: API version 51.0
- Description: The state of the order item that the billing schedule represents.
- Possible values:
- CompletelyBilled — CompletelyBilled
- Error — Error
- Processing — Processing
- ReadyForInvoicing — ReadyForInvoicing
- Type: picklist
- Properties: Filter, Group, Nillable, Restricted picklist, Sort
- Introduced: API version 67.0
-
Type: reference
-
Properties: Create, Filter, Group, Sort
-
Introduced: API version 55.0
-
Description:
Shows the treatment used to calculate tax for the billing schedule. Defined based on the order item’s tax policy.
This field is a relationship field.
-
Relationship name: TaxTreatment
-
Relationship type: relationship
-
Refers to: TaxTreatment
- Type: currency
- Properties: Filter, Nillable, Sort
- Description: The total amount of the order item represented by the billing schedule.
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
- Type: picklist
- Properties: Filter, Group, Restricted picklist, Sort
- Type: currency
- Properties: Create, Defaulted on create, Filter, Nillable, Sort
- Description: The price for an individual unit of the billing schedule’s parent order item, including charges, adjustments, and discounts. Inherited from the order item’s
UnitPricefield.
- Type: double
- Properties: Filter, Nillable, Sort
- Introduced: API version 63.0
-
Type: reference
-
Properties: Create, Filter, Group, Nillable, Sort
-
Introduced: API version 62.0
-
Relationship name: UsageResource
-
Relationship type: relationship
-
Refers to: UsageResource