BillingSchedule

Stores the order item information used in the invoicing process. This object is available in API version 55.0 and later.

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.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), update()

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field	Details
BillDayOfMonth	Type int Properties Filter, Group, Nillable, Sort Description An integer from 1 to 31 that indicates the day of the month.
BilledAmount	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.
BillingAccountId	Type reference Properties Filter, Group, Sort Description This field is a relationship field. Relationship Name BillingAccount Refers To Account
BillingPeriodAmount	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.
BillingScheduleEndDate	Type date Properties 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.
BillingScheduleGroupId	Type reference Properties 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 Lookup Refers To BillingScheduleGroup
BillingScheduleNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Autogenerated reference number for the billing schedule.
BillingScheduleStartDate	Type date Properties Filter, Group, Nillable, Sort Description The date that the billing schedule is available for invoicing. Inherited from the ServiceDate on the order item.
BilledThroughPeriod	Type date Properties Filter, Group, Nillable, Sort Description The last billing period that includes this date.
BillingTreatmentItemId	Type reference Properties Filter, Group, Sort 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 Lookup Refers To BillingTreatmentItem
CancellationDate	Type date Properties Filter, Group, Nillable, Sort 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.
Category	Type picklist Properties 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
CurrencyIsoCode	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Three-letter ISO 4217 currency code associated with the invoice. The default value is USD.
InvoiceBatchRunId	Type reference Properties Filter, Group, Nillable, Sort 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 Lookup Refers To InvoiceBatchRun
InvoiceRunBatch	Type picklist Properties Filter, Group, Nillable, Sort Description The batch value used by the invoice run that evaluated this billing schedule. During an invoice run, billing schedules with the same batch value (including null) are grouped to the same invoice run. For example, create one batch of invoices for Premium Customers and another batch for Regular Customers. Possible values are: Premium Customers Regular Customers
NextBillingDate	Type date Properties Filter, Group, Nillable, Sort 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.
NextChargeFromDate	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 NextChargeFromDate is 02/01/22.
OriginalBillingScheduleId	Type reference Properties Filter, Group, Nillable, Sort 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 Lookup Refers To BillingSchedule
PendingAmount	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.
Quantity	Type double Properties Filter, Nillable, Sort Description The quantity of the order item that created the billing schedule.
ReferenceEntityId	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 Lookup Refers To Order
ReferenceEntityItemId	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 Lookup Refers To OrderItem, OrderItemAdjustementLineTime, or OrderItemSummary
Status	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The state of the order item that the billing schedule represents. Possible values are: `CompletelyBilled` `Error` `Processing` `ReadyForInvoicing`
TaxTreatmentId	Type reference Properties Filter, Group, Sort 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 Lookup Refers To TaxTreatment
TotalAmount	Type currency Properties Filter, Nillable, Sort Description The total amount of the order item represented by the billing schedule.
UnitPrice	Type currency Properties 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 UnitPrice field.

Object Reference for the Salesforce Platform

BillingSchedule

Supported Calls

Special Access Rules

Fields