Documentation

Fields

• lineItemRefundAmount :: Maybe Float

  amount: The specific amount to be refunded from the adjustment. Must be less than or equal to the adjustment's remaining balance. If `quantity`, `quantity_decimal` and `percentage` are not present, `amount` is required. If `quantity`, `quantity_decimal`, or `percentage` is present, `amount` must be absent.

• lineItemRefundId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• lineItemRefundPercentage :: Maybe Int

  percentage: The percentage of the adjustment's remaining balance to refund. If `quantity`, `quantity_decimal` and `amount_in_cents` are not present, `percentage` is required. If `quantity`, `quantity_decimal` or `amount_in_cents` is present, `percentage` must be absent.

  Constraints:

  • Maxium of 100.0
  • Minimum of 1.0
• lineItemRefundProrate :: Maybe Bool

  prorate: Set to `true` if the line item should be prorated; set to `false` if not. This can only be used on line items that have a start and end date.

• lineItemRefundQuantity :: Maybe Int

  quantity: Line item quantity to be refunded. Must be less than or equal to the `quantity_remaining`. If `quantity_decimal`, `amount`, and `percentage` are not present, `quantity` is required. If `amount` or `percentage` is present, `quantity` must be absent.

• lineItemRefundQuantity_decimal :: Maybe Text

  quantity_decimal: Decimal quantity to refund. The `quantity_decimal` will be used to refund charges that has a NOT null quantity decimal. Must be less than or equal to the `quantity_decimal_remaining`. If `quantity`, `amount`, and `percentage` are not present, `quantity_decimal` is required. If `amount` or `percentage` is present, `quantity_decimal` must be absent. The Decimal Quantity feature must be enabled to utilize this field.