---
schema_version: "1"
id: 73aa9e8a0e2b70598dc19ee1a066f80e5174d54ce2f2b36749f79290e4dc385f
title: PaymentSchedulePolicy
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_paymentschedulepolicy.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentschedulepolicy.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: dcc2f51227a2d7d355a602958b1bdd9e4fdde9f7226aa2c11ab1a182949250c4
description: Contains configuration information for the payment schedule policy. This object is available in API version 56.0 and later.
---
# PaymentSchedulePolicy

Contains configuration information for the payment schedule policy. This object is available in API version 56.0 and later.

## Supported Calls

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

## Special Access Rules

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](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentschedulepolicy.htm "HTML (New Window)").

## Fields

| Field | Details |
| --- | --- |
| DefaultTreatmentId | 
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

Lookup

Refers To

PaymentScheduleTreatment



 |
| Description | 

Type

textarea

Properties

Create, Filter, Nillable, Sort, Update

Description

User-entered description of the payment schedule policy.



 |
| IsOrgDefault | 

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.



 |
| 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

The user-entered name of the payment policy.



 |
| OwnerId | 

Type

reference

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

ID of the creator of this object.

This field is a polymorphic relationship field.

Relationship Name

Owner

Relationship Type

Lookup

Refers To

Group, User



 |
| Status | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

The payment schedule policy’s status.

Possible values are:

- Active
- Canceled
- Draft
- Inactive





 |
| TreatmentSelection | 

Type

picklist

Properties

Create, Filter, Group, Restricted picklist, Sort, Update

Description

Indicates the payment schedule treatment.

Possible values are:

- Default—use the payment schedule treatment indicated by DefaultTreatmentId.





 |