ProrationPolicy

Defines how the price of a subscription is divided into time periods and how the price is calculated for each time period.

The proration policy defines whether partial periods are allowed and how remainder amounts are handled.

Introduced in API version 55.0.

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

  • This object is available when Subscription Management is enabled.

  • Type: boolean

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

  • Description:

    Indicates whether a subscription can be canceled partway through a period.

    Set the value to True if a subscription can be canceled partway through a period. Otherwise, set the value to false.

    For example, if the proration period is monthly and this field is true, then customers can cancel a subscription partway through the month. If the proration period is monthly and this field is false, then the subscription is canceled at the end of the current month.

    The default value is false.

  • Default value: false

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort
  • Description: The name of the proration policy.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort
  • Description: The type of proration policy.
  • Possible values:
    • StandardTimePeriods — StandardTimePeriods — Indicates that the proration policy divides the subscription into similar time periods, and prorates the subscription using the time periods. For example, a monthly subscription that’s subscribed to for 12 months for a total amount of $120 is prorated as $10 per month.

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort

  • Description:

    Indicates how the leftover amount from the price calculation is allocated.

    For example, if the total amount is $100 and the subscription has 12 periods, the price per period is $8.33, with $0.04 remaining. To indicate that the $0.04 is included in the first period, use the value AddToFirst. To indicate that the $0.04 is included in the final period, use the value AddToLast.

  • Possible values:

    • AddToFirst — AddToFirst — Add the remaining amount to the first period.
    • AddToLast — AddToLast — Add the remaining amount to the last period.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 66.0