Mark Invoice Successful

Invoice ID or number. For ID no prefix is used e.g. `e28zov4fw0v2`. For number use prefix `number-`, e.g. `number-1000`. For number with prefix or country code, use `number-` and `prefix`, e.g. `number-TEST-FR1001`

Invoices are either charge, credit, or legacy invoices.

One ofchargecreditlegacy

The event that created the invoice.

One ofcarryforward_creditcarryforward_gift_creditcreditexternal_refundgift_cardimmediate_changeimportline_item_refundopen_amount_refundprepaymentpurchaserefundrenewalterminationusage_correctionwrite_off

One ofopenpendingprocessingpast_duepaidclosedfailedvoidedDefault "all"

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 `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature.

If the invoice is charging or refunding for one or more subscriptions, these are their IDs.

On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.

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.

An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.

One ofautomaticmanualDefault "automatic"

For manual invoicing, this identifies the PO number associated with the subscription.

Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example: If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month. For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`. For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.

Default 0

Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.

One ofneteomDefault "net"

State or province.

Zip or postal code.

Country, 2-letter ISO 3166-1 alpha-2 code.

Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled.

3-letter ISO 4217 currency code.

Total discounts applied to this invoice.

The coupon redemptions applied to this invoice.

Will always be `coupon`.

One ofactiveinactive

The amount that was discounted upon the application of the coupon, formatted with the currency.

The summation of charges and credits, before discounts and taxes.

The summation of charges and credits, after discounts applied.

The total tax on this invoice.

3-letter ISO 4217 currency code.

The subtotal converted to the currency.

The tax converted to the currency.

The conversion rate to the currency.

The source of the conversion rate.

The date of the conversion rate.

The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.

The refundable amount on a charge invoice. It will be null for all other invoices.

The total amount of successful payments transaction on this invoice.

The outstanding balance remaining on this invoice.

Only for merchants using Recurly's In-The-Box taxes.

Provides the tax type as "vat" for EU VAT, "usst" for U.S. Sales Tax, or the 2 letter country code for country level tax types like Canada, Australia, New Zealand, Israel, and all non-EU European countries. Not present when Avalara for Communications is enabled.

Provides the tax region applied on an invoice. For U.S. Sales Tax, this will be the 2 letter state code. For EU VAT this will be the 2 letter country code. For all country level tax types, this will display the regional tax, like VAT, GST, or PST. Not present when Avalara for Communications is enabled.

The combined tax rate. Not present when Avalara for Communications is enabled.

Provides additional tax details for Communications taxes when Avalara for Communications or Vertex Tax Breakdown is enabled or Canadian Sales Tax. Tax details will only be populated for the Invoice response when fetching a single invoice and not for the InvoiceList or LineItemList. Only populated for a single LineItem fetch when Avalara for Communications is enabled.

Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service.

VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.

VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription.

This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.

This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.

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 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.

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.

Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.

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

If this transaction is a refund (`type=refund`), this will be the ID of the original transaction on the invoice being refunded.

Must be sent for one-time transactions in order to provide context on which entity is submitting the transaction to ensure proper fraud checks are observed, such as 3DS. If the customer is in session, send `customer`. If this is a merchant initiated one-time transaction, send `merchant`.

One ofcustomermerchant

This conditional parameter is useful for merchants in specific industries who need to submit one-time Merchant Initiated transactions in specific cases. Not all gateways support these methods, but will support a generic one-time Merchant Initiated transaction. Only use this if the initiator value is "merchant". Otherwise, it will be ignored. - Incremental: Send `incremental` with an additional purchase if the original authorization amount is not sufficient to cover the costs of your service or product. For example, if the customer adds goods or services or there are additional expenses. - No Show: Send `no_show` if you charge customers a fee due to an agreed-upon cancellation policy in your industry. - Resubmission: Send `resubmission` if you need to attempt collection on a declined transaction. You may also use the force collection behavior which has the same effect. - Service Extension: Send `service_extension` if you are in a service industry and the customer has increased/extended their service in some way. For example: adding a day onto a car rental agreement. - Split Shipment: Send `split_shipment` if you sell physical product and need to split up a shipment into multiple transactions when the customer is no longer in session. - Top Up: Send `top_up` if you process one-time transactions based on a pre-arranged agreement with your customer where there is a pre-arranged account balance that needs maintaining. For example, if the customer has agreed to maintain an account balance of 30.00 and their current balance is 20.00, the MIT amount would be at least 10.00 to meet that 30.00 threshold.

One ofincrementalno_showresubmissionservice_extensionsplit_shipmenttop_upDefault "none"

If the transaction is charging or refunding for one or more subscriptions, these are their IDs.

- `authorization` – verifies billing information and places a hold on money in the customer's account. - `capture` – captures funds held by an authorization and completes a purchase. - `purchase` – combines the authorization and capture in one transaction. - `refund` – returns all or a portion of the money collected in a previous transaction to the customer. - `verify` – a $0 or $1 transaction used to verify billing information which is immediately voided.

One ofauthorizationcapturepurchaserefundverify

Describes how the transaction was triggered.

One ofapichargebackexternal_recoveryforce_collecthppmerchantrecurly_adminrecurlyjsrecurringrefunded_externallytransparenttoken_apiapi_force_collectapi_sub_changeapi_verify_cardrefund_balanceamazon_v2_ipn

3-letter ISO 4217 currency code.

The description that gets sent to the gateway.

Total transaction amount sent to the payment gateway.

The current transaction status. Note that the status may change, e.g. a `pending` transaction may become `declined` or `success` may later become `void`.

One ofchargebackdeclinederrorpendingprocessingscheduledsuccessvoid

Did this transaction complete successfully?

Indicates if the transaction was completed using a backup payment

Indicates if part or all of this transaction was refunded.

The method by which the payment was collected.

One ofautomaticmanual

IP address provided when the billing information was collected: - When the customer enters billing information into the Recurly.js or Hosted Payment Pages, Recurly records the IP address. - When the merchant enters billing information using the API, the merchant may provide an IP address. - When the merchant enters billing information using the UI, no IP address is recorded.

For declined (`success=false`) transactions, the message displayed to the merchant.

For declined (`success=false`) transactions, the message displayed to the customer.

Transaction message from the payment gateway.

Transaction reference number from the payment gateway.

Time, in seconds, for gateway to process the transaction.

The values in this field will vary from gateway to gateway.

When processed, result from checking the CVV/CVC value on the transaction.

One ofDIMNPSUX

When processed, result from checking the overall AVS on the transaction.

One ofABCDEFGHIJKLMNOPQRSTUVWXYZ

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

The action for which the credit was created.

One ofpaymentreductionrefundwrite_off

3-letter ISO 4217 currency code.

Total credit payment amount applied to the charge invoice.

For credit payments with action `refund`, this is the credit payment that was refunded.