PixRecurring class abstract

PixRecurring

Properties:

  • billingDate - The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
  • businessDayOnly - Flag used to define whether liquidation can happen only on business days
  • endsAt - End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
  • frequency - The frequency at which the shopper will be charged.
  • minAmount - For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.
  • originalPspReference - The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
  • recurringAmount - For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment.
  • recurringStatement - The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
  • retryPolicy - When set to true, you can retry for failed recurring payments. The default value is true.
  • startsAt - Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
Annotations
  • @BuiltValue.new()

Constructors

PixRecurring([void updates(PixRecurringBuilder b)])
factory

Properties

billingDate → String?
The date on which the shopper's payment method will be charged, in YYYY-MM-DD format.
no setter
businessDayOnly → bool?
Flag used to define whether liquidation can happen only on business days
no setter
endsAt → String?
End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper.
no setter
frequency → PixRecurringFrequencyEnum?
The frequency at which the shopper will be charged.
no setter
hashCode → int
The hash code for this object.
no setterinherited
minAmount → Amount?
For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.
no setter
originalPspReference → String?
The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date.
no setter
recurringAmount → Amount?
For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment.
no setter
recurringStatement → String?
The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
no setter
retryPolicy → bool?
When set to true, you can retry for failed recurring payments. The default value is true.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startsAt → String?
Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PixRecurringBuilder)) → PixRecurring
Rebuilds the instance.
inherited
toBuilder() → PixRecurringBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PixRecurring>
no setter