Interface ScheduledChange.Builder

  • Method Details

    • changeType

      ScheduledChange.Builder changeType(String changeType)

      The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

      Parameters:
      changeType - The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • changeType

      The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).

      Parameters:
      changeType - The type of pending change. Possible values are DOWNGRADE (a tier change to a lower level) and CANCELLATION (subscription termination).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • effectiveDate

      ScheduledChange.Builder effectiveDate(Instant effectiveDate)

      The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.

      Parameters:
      effectiveDate - The date and time when the change takes effect, in ISO 8601 format. This value is populated after the change is confirmed by the billing system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • planTier

      ScheduledChange.Builder planTier(String planTier)

      For downgrades, the tier level that the subscription will change to. Not present for cancellations.

      Parameters:
      planTier - For downgrades, the tier level that the subscription will change to. Not present for cancellations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • usageLevel

      ScheduledChange.Builder usageLevel(String usageLevel)

      For downgrades, the target usage level after the change takes effect.

      Parameters:
      usageLevel - For downgrades, the target usage level after the change takes effect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.