Contents

RefundLineItem

The line item that indicates a refund transaction.

Declaration

object RefundLineItem

Properties

NameTypeDescription
lineItemId RequiredlineItemId

A unique identifier for the transaction, that you determine. The value must be unique per app. Using UUIDs is recommended. Reuse a lineItemId only to submit a correction for a previously submitted line item.

referenceLineItemId RequiredreferenceLineItemId

The lineItemId of the initial purchase transaction that receives a refund.

creationDate RequiredcreationDate

The UNIX date, in milliseconds, you completed the transaction.

restatementrestatement

Set to true to indicate that this line item is correcting (restating) a refund line item that you previously submitted. For more information, see Reporting corrections.

erroneouslySubmittederroneouslySubmitted

Set to true to indicate that you previously submitted the line item in error. Set the restatement field to true also. For more information, see Reporting corrections.

pricingCurrency RequiredpricingCurrency

The currency the transaction used to charge or refund the customer. For more information, see pricingCurrency.

reportingCurrency RequiredreportingCurrency

The currency you use to report all the amount fields, including amountTaxExclusive, amountTaxInclusive, netAmountTaxExclusive, and taxAmount. For more information, see reportingCurrency.

exchangeRateexchangeRate

The exchange rate you use to calculate the amounts, from the pricing currency to the reporting currency, if the customer is billed in an unsupported currency. For more information, see exchangeRate.

amountTaxExclusive RequiredamountTaxExclusive

The amount that the customer paid, excluding taxes, that you state in milli-units of the reporting currency. For more information, see amountTaxExclusive.

amountTaxInclusive RequiredamountTaxInclusive

The amount that the customer paid, including taxes, that you state in milli-units of the reporting currency. For more information, see amountTaxInclusive.

netAmountTaxExclusive RequirednetAmountTaxExclusive

The net amount the customer was charged, accurate to the current line item, that you state in milli-units of the reporting currency. This amount excludes tax, and accounts for all refunds and restatements. For more information, see netAmountTaxExclusive.

taxAmount RequiredtaxAmount

The amount the customer paid in taxes, that you state in milli-units of the reporting currency. For more information, see taxAmount.

taxCountry RequiredtaxCountry

The country code of the country for which taxes were paid on the purchase. For more information, see taxCountry.

eventType RequiredeventType

Use REFUND.

Mentioned in

Discussion

Use a RefundLineItem to report either:

  • A refund for a purchase transaction you previously submitted, or

  • A correction to a refund you previously submitted

For more information about sending a report that includes refund line items, see Reporting tokens with transactions.

Report chargebacks as a refund.

See Also

External purchase report transactions