Documentation

Fields

• invoiceRefundAmount :: Maybe Float

  amount: The amount to be refunded. The amount will be split between the line items. If `type` is "amount" and no amount is specified, it will default to refunding the total refundable amount on the invoice. Can only be present if `type` is "amount".

• invoiceRefundCredit_customer_notes :: Maybe Text

  credit_customer_notes: Used as the Customer Notes on the credit invoice.

  This field can only be include when the Credit Invoices feature is enabled.

• invoiceRefundExternal_refund :: Maybe InvoiceRefundExternal_refund

  external_refund: Indicates that the refund was settled outside of Recurly, and a manual transaction should be created to track it in Recurly.

  Required when: - refunding a manually collected charge invoice, and `refund_method` is not `all_credit` - refunding a credit invoice that refunded manually collecting invoices - refunding a credit invoice for a partial amount

  This field can only be included when the Credit Invoices feature is enabled.

• invoiceRefundLine_items :: Maybe [LineItemRefund]

  line_items: The line items to be refunded. This is required when `type=line_items`.

• invoiceRefundPercentage :: Maybe Int

  percentage: The percentage of the remaining balance to be refunded. The percentage will be split between the line items. If `type` is "percentage" and no percentage is specified, it will default to refunding 100% of the refundable amount on the invoice. Can only be present if `type` is "percentage".

  Constraints:

  • Maxium of 100.0
  • Minimum of 1.0
• invoiceRefundRefund_method :: Maybe InvoiceRefundRefund_method

  refund_method: Indicates how the invoice should be refunded when both a credit and transaction are present on the invoice: - `transaction_first` – Refunds the transaction first, then any amount is issued as credit back to the account. Default value when Credit Invoices feature is enabled. - `credit_first` – Issues credit back to the account first, then refunds any remaining amount back to the transaction. Default value when Credit Invoices feature is not enabled. - `all_credit` – Issues credit to the account for the entire amount of the refund. Only available when the Credit Invoices feature is enabled. - `all_transaction` – Refunds the entire amount back to transactions, using transactions from previous invoices if necessary. Only available when the Credit Invoices feature is enabled.

• invoiceRefundType :: InvoiceRefundType

  type: The type of refund. Amount and line items cannot both be specified in the request.

Fields

• invoiceRefundExternal_refundDescription :: Maybe Text

  description: Used as the refund transactions' description.

  Constraints:

  • Maximum length of 50
• invoiceRefundExternal_refundPayment_method :: InvoiceRefundExternal_refundPayment_method

  payment_method: Payment method used for external refund transaction.

• invoiceRefundExternal_refundRefunded_at :: Maybe JsonDateTime

  refunded_at: Date the external refund payment was made. Defaults to the current date-time.