Class CreateBillEstimateResponse

    • Method Detail

      • id

        public final String id()

        The unique identifier of your newly created Bill estimate.

        Returns:
        The unique identifier of your newly created Bill estimate.
      • name

        public final String name()

        The name of your newly created Bill estimate.

        Returns:
        The name of your newly created Bill estimate.
      • status

        public final BillEstimateStatus status()

        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

        If the service returns an enum value that is not available in the current SDK version, status will return BillEstimateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
        See Also:
        BillEstimateStatus
      • statusAsString

        public final String statusAsString()

        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

        If the service returns an enum value that is not available in the current SDK version, status will return BillEstimateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
        See Also:
        BillEstimateStatus
      • failureMessage

        public final String failureMessage()

        This attribute provides the reason if a Bill estimate result generation fails.

        Returns:
        This attribute provides the reason if a Bill estimate result generation fails.
      • billInterval

        public final BillInterval billInterval()

        The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

        Returns:
        The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.
      • costSummary

        public final BillEstimateCostSummary costSummary()

        Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

        Returns:
        Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.
      • createdAt

        public final Instant createdAt()

        The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

        Returns:
        The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).
      • expiresAt

        public final Instant expiresAt()

        The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

        Returns:
        The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object