Newer Version Available

This content describes an older version of this product. View Latest

BillingPolicy

Represents a group of billing treatments, which define the rules for how to invoice a customer for an order item. This object is available in API version 55.0 and later.

Billing policies are related to products, which pass the policy on to the resulting order items. When an order is activated, Subscription Management assigns a billing treatment to each order item based on the values in the BillingTreatmentSelection field. Then Subscription Management uses the billing treatment to create billing schedules.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field Details
BillingTreatmentSelection
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
Defines how Subscription Management assigns billing treatments to order items and to assets related to the billing policy.
Possible values are:
  • Default—The value specified in the DefaultBillingTreatmentId field is automatically applied to order items and assets.
  • Manual—Users must specify the billing treatment that's applied to the order items and assets.
DefaultBillingTreatmentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
When BillingTreatmentSelection has a value of Default, Subscription Management uses the selected billing treatment for all order items and assets related to the billing policy.
This field is a relationship field.
Relationship Name
DefaultBillingTreatment
Relationship Type
Lookup
Refers To
BillingTreatment
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Optional user-defined description that describes the billing policy.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Optional user-defined name for the billing policy.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The billing policy's status.
Possible values are:
  • Active—Indicates that the billing policy is available for use on products.
  • Draft—Indicates that the billing policy isn't available for use on products. Use this status when creating billing policies that aren't ready to be activated.
  • Inactive—Indicates that the billing policy isn't available for use on products.