PaymentSchedulePolicy

Contains configuration information for the payment schedule policy.

Introduced in API version 56.0.

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

  • This object is available with Subscription Management and the PaymentScheduleAutomation permission, 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 default payment schedule treatment.

    This field is a relationship field.

  • Relationship name: DefaultTreatment

  • Relationship type: relationship

  • Refers to: PaymentScheduleTreatment

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: User-entered description of the payment schedule policy.
  • Type: boolean

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

  • Description:

    true if the payment schedule policy is the default policy for the org, otherwise false. An org can have a maximum of one default payment policy.

    The default value is false.

  • Default value: false

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The user-entered name of the payment policy.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The payment schedule policy’s status.
  • Possible values:
    • Active — Active
    • Canceled — Canceled
    • Draft — Draft
    • Inactive — Inactive
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Indicates the payment schedule treatment.
  • Possible values:
    • Default — Default — use the payment schedule treatment indicated by DefaultTreatmentId.

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.