Create Line Item

Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

3-letter ISO 4217 currency code. If `item_code`/`item_id` is part of the request then `currency` is optional, if the site has a single default currency. `currency` is required if `item_code`/`item_id` is present, and there are multiple currencies defined on the site. If `item_code`/`item_id` is not present `currency` is required.

A positive or negative amount with `type=charge` will result in a positive `unit_amount`. A positive or negative amount with `type=credit` will result in a negative `unit_amount`. If `item_code`/`item_id` is present, `unit_amount` can be passed in, to override the `Item`'s `unit_amount`. If `item_code`/`item_id` is not present then `unit_amount` is required.

Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to use this flag.

Default false

This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.

Default 1

Description that appears on the invoice. If `item_code`/`item_id` is part of the request then `description` must be absent.

Unique code to identify an item. Available when the Credit Invoices feature is enabled.

System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.

One ofat_invoiceat_range_endat_range_startevenlynever

Line item type. If `item_code`/`item_id` is present then `type` should not be present. If `item_code`/`item_id` is not present then `type` is required.

One ofchargecredit

The reason the credit was given when line item is `type=credit`. When the Credit Invoices feature is enabled, the value can be set and will default to `general`. When the Credit Invoices feature is not enabled, the value will always be `null`.

One ofgeneralpromotionalserviceDefault "general"

Accounting Code for the `LineItem`. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

`true` exempts tax on charges, `false` applies tax on charges. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative line items). Credits are always applied post-tax. Pre-tax discounts should use the Coupons feature.

Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_transaction_type` must be absent.

Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the line item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types. If an `Item` is associated to the `LineItem`, then the `avalara_service_type` must be absent.

Used by Vertex for tax calculations. Possible values are sale, rental, lease.

One ofsalerentallease

Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.

The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals. If `item_code`/`item_id` is part of the request then `harmonized_system_code` must be absent.

Optional field to track a product code or SKU for the line item. This can be used to later reporting on product purchases. For Vertex tax calculations, this field will be used as the Vertex `product` field. If `item_code`/`item_id` is part of the request then `product_code` must be absent.

Origin `external_gift_card` is allowed if the Gift Cards feature is enabled on your site, `type` is `credit` and `tax_exempt` is `true` if you are using taxes. Set this value in order to track gift card credits from external gift cards (like InComm). It also skips billing information requirements. Origin `prepayment` is only allowed if `type` is `charge` and `tax_exempt` is left blank or set to true. This origin creates a charge and opposite credit on the account to be used for future invoices.

One ofexternal_gift_cardprepayment

The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

Fields must be created in the UI before values can be assigned to them.

Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.

The type of record a custom field was automatically copied from.

One ofaccountplanproductsubscription

The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.

If an end date is present, this is value indicates the beginning of a billing time range. If no end date is present it indicates billing for a specific date. Defaults to the current date-time.

If this date is provided, it indicates the end of a time range.

The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".

One oforigindestinationDefault "origin"

The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".

One ofdestinationoriginDefault "destination"

The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

Charges are positive line items that debit the account. Credits are negative line items that credit the account.

One ofchargecredit

Unique code to identify an item. Available when the Credit Invoices feature is enabled.

System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.

Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.

One ofat_invoiceat_range_endat_range_startevenlynever

Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.

One ofinvoicedpending

Category to describe the role of a line item on a legacy invoice: - "charges" refers to charges being billed for on this invoice. - "credits" refers to refund or proration credits. This portion of the invoice can be considered a credit memo. - "applied_credits" refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated. - "carryforwards" can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.

One ofapplied_creditcarryforwardchargecredit

The unique identifier of the account.

The email address used for communicating with this customer.

Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used.

The UUID of the account responsible for originating the line item.

If the line item is a charge or credit for a subscription, this is its ID.

If the line item is a charge or credit for a plan or add-on, this is the plan's ID.

If the line item is a charge or credit for a plan or add-on, this is the plan's code.

If the line item is a charge or credit for an add-on this is its ID.

If the line item is a charge or credit for an add-on, this is its code.

Once the line item has been invoiced this will be the invoice's ID.

Once the line item has been invoiced this will be the invoice's number. If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence.

Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.

The invoice where the credit originated. Will only have a value if the line item is a credit created from a previous credit, or if the credit was created from a charge refund.

A credit created from an original charge will have the value of the charge's origin.

One ofadd_onadd_on_trialcarryforwardcouponcreditdebitone_timeplanplan_trialsetup_feeprepayment

Internal accounting code to help you reconcile your revenue to the correct ledger. Line items created as part of a subscription invoice will use the plan or add-on's accounting code, otherwise the value will only be present if you define an accounting code when creating the line item.

For plan-related line items this will be the plan's code, for add-on related line items it will be the add-on's code. For item-related line items it will be the item's `external_sku`.

The reason the credit was given when line item is `type=credit`.

One ofgeneralgift_cardpromotionalrefundservicewrite_offDefault "general"

3-letter ISO 4217 currency code.

`(quantity * unit_amount) - discount + tax`

Description that appears on the invoice. For subscription related items this will be filled in automatically.

This number will be multiplied by the unit amount to compute the subtotal before any discounts or taxes.

Default 1

A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field.

Positive amount for a charge, negative amount for a credit.

Positive amount for a charge, negative amount for a credit.

Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.

`quantity * unit_amount`

The sum of all discounts applied to the line item.

The breakdown of discounts applied to the line item by coupon redemption.

Will always be `line_item_discount`.

The ID of the coupon that generated this discount.

The ID of the coupon redemption that generated this discount.

The order in which this discount was applied when multiple coupons were redeemed.

The amount discounted on this line item by this coupon redemption.

3-letter ISO 4217 currency code.

Unique code to identify the ledger account. Each code must start with a letter or number. The following special characters are allowed: `-_.,:`

Unique code to identify the ledger account. Each code must start with a letter or number. The following special characters are allowed: `-_.,:`

The ID of a performance obligation. Performance obligations are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.

The tax amount for the line item.