BillingTreatment

Defines how Subscription Management bills an order item. The Exclude From Billing field controls whether the order item is invoiced. Child billing treatment items control how much of the order item’s balance is invoiced for each invoice across the subscription’s lifecycle. Billing treatments are assigned to order items based on the parent billing policy’s Billing Treatment Selection field.

Introduced in API version 55.0.

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

  • 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: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The ID of the billing policy for the billing treatment.

    This field is a relationship field.

  • Relationship name: BillingPolicy

  • Relationship type: relationship

  • Refers to: BillingPolicy

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 66.0

  • Default value: false

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Optional user-defined description of the billing treatment.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Excludes any order items assigned to the treatment from creating billing schedules.
  • Possible values:
    • No — No
    • Yes — Yes

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 62.0

  • Default value: false

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The ID of the legal entity used to assign the treatment to order items when the parent billing policy’s BillingTreatmentSelection is LegalEntity.

    This field is a relationship field.

  • Relationship name: LegalEntity

  • Relationship type: relationship

  • Refers to: LegalEntity

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Optional user-defined name for the billing treatment.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Draft or inactive billing treatments can’t be assigned to order items.
  • Possible values:
    • Active — Active
    • Draft — Draft
    • Inactive — Inactive

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.