Contents

OneTimeBuyLineItem

The line item that indicates a one-time charge transaction.

Declaration

object OneTimeBuyLineItem

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 restatement for a previously submitted line item.

creationDate RequiredcreationDate

The UNIX date, in milliseconds, that the customer authorized the purchase.

restatementrestatement

Set to true to indicate that this line item is correcting (restating) a 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 erroneously. Set the restatement field to true also. For more information, see Reporting corrections.

pricingCurrency RequiredpricingCurrency

The currency the transaction used to charge 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 report, 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.

productIdentifier RequiredproductIdentifier

A string that uniquely identifies the product.

quantity Requiredquantity

The quantity of the product the customer purchased.

eventType RequiredeventType

Use BUY. (To report refunds or subscription-related transactions, use RefundLineItem or SubscriptionBuyLineItem line items instead.)

productType RequiredproductType

Use ONE_TIME_BUY. (To report a subscription-related transaction, use a SubscriptionBuyLineItem instead.)

Mentioned in

Discussion

Use a OneTimeBuyLineItem to report a one-time charge transaction, or a correction to a one-time charge transaction that you previously submitted.

Each line-item object represents one transaction. Other types of line-item objects include:

Include the line-item objects in the lineItems array of an ExternalPurchaseReport object. To send the report, include the ExternalPurchaseReport object in a request to the Send External Purchase Report endpoint.

For more information, see Reporting tokens with transactions and Reporting corrections.

See Also

External purchase report transactions