Interface ExpectedCharge.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ExpectedCharge.Builder,ExpectedCharge>, SdkBuilder<ExpectedCharge.Builder,ExpectedCharge>, SdkPojo
Enclosing class:
ExpectedCharge
@Mutable @NotThreadSafe public static interface ExpectedCharge.Builder extends SdkPojo, CopyableBuilder<ExpectedCharge.Builder,ExpectedCharge>

  • Method Details

    • id

      ExpectedCharge.Builder id(String id)

      Unique identifier of the charge for a given agreement.

      Parameters:
      id - Unique identifier of the charge for a given agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • time

      ExpectedCharge.Builder time(Instant time)

      The date and time when the charge is due to be invoiced. This is available only when the charge date is known.

      Parameters:
      time - The date and time when the charge is due to be invoiced. This is available only when the charge date is known.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • amount

      ExpectedCharge.Builder amount(String amount)

      The tax-exclusive amount of the charge. Only available when the charge amount is known.

      Parameters:
      amount - The tax-exclusive amount of the charge. Only available when the charge amount is known.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • amountAfterTax

      ExpectedCharge.Builder amountAfterTax(String amountAfterTax)

      The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.

      Parameters:
      amountAfterTax - The tax-inclusive amount the acceptor has to pay. The amount is only present for fixed charges.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timing

      ExpectedCharge.Builder timing(String timing)

      Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).

      Parameters:
      timing - Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • timing

      ExpectedCharge.Builder timing(Timing timing)

      Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).

      Parameters:
      timing - Indicates when the charge amount will be incurred. Values include ON_ACCEPTANCE (charged immediately when the agreement request is accepted), BILLING_PERIOD (charged on each billing period), and SCHEDULED (charged at a predetermined future date).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • estimatedTaxes

      ExpectedCharge.Builder estimatedTaxes(EstimatedTaxes estimatedTaxes)

      Provides an aggregated view of estimated tax information for this specific charge.

      Parameters:
      estimatedTaxes - Provides an aggregated view of estimated tax information for this specific charge.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • estimatedTaxes

      default ExpectedCharge.Builder estimatedTaxes(Consumer<EstimatedTaxes.Builder> estimatedTaxes)

      Provides an aggregated view of estimated tax information for this specific charge.

      This is a convenience method that creates an instance of the EstimatedTaxes.Builder avoiding the need to create one manually via EstimatedTaxes.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to estimatedTaxes(EstimatedTaxes).

      Parameters:
      estimatedTaxes - a consumer that will call methods on EstimatedTaxes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: