Invoices - Ionic Docs

Invoices let you record pending charges for a customer, compose them into a document with a gapless number, and collect payment off-session or by directing the buyer to a hosted page. On Node, npm install @ionicfi/sdk gives you typed calls for every request below; the server SDK guide has details. Each example also shows raw curl.

Lifecycle

(Optional) Record pending charges

Create invoice items against a customer before invoicing. When you create an invoice for that customer, every pending item in the invoice currency drains onto the new draft automatically.

Create a draft invoice

Call POST /v1/invoices with a customer, currency, and collection method. The draft starts with all pending items already applied as lines. Drafts carry no number and do not appear in sequences.

Edit the draft

Add or remove individual lines before finalizing. Totals recompute on each change.

Finalize

Call POST /v1/invoices/{id}/finalize to assign a sequential number, apply tax, and freeze the lines. A zero-total invoice transitions directly to paid.

Collect payment

For charge_automatically invoices, call POST /v1/invoices/{id}/pay. For send_invoice invoices, Ionic provides a hosted invoice page where the buyer pays directly.

Record pending charges

Invoice items record a charge against a customer without immediately billing them. When you create an invoice for that customer, all pending items in the invoice currency are drained onto it as lines and cleared from the pending queue.

import { Ionic } from "@ionicfi/sdk";

const ionic = new Ionic({ token: process.env.IONIC_SECRET_KEY });

const item = await ionic.invoices.items.create({
  "Idempotency-Key": "ii_seats_feb_cus_abc",
  customer: "cus_000000000000000000000000",
  description: "5 additional seats — February",
  quantity: 5,
  unit_amount: 1000,
  currency: "usd",
});

curl https://api.ionicfi.com/v1/invoice_items \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "Idempotency-Key: ii_seats_feb_cus_abc" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "cus_000000000000000000000000",
    "description": "5 additional seats — February",
    "quantity": 5,
    "unit_amount": 1000,
    "currency": "usd"
  }'

Field	Type	Notes
`customer`	string	Required. Customer id (`cus_…`).
`description`	string	Required. Display label for this charge.
`quantity`	integer	Required. Minimum 1.
`unit_amount`	integer	Required. Per-unit price in minor units (e.g., cents for USD).
`currency`	string	Required. Lowercase ISO currency code. Must match the invoice currency when the item drains.
`price`	string	Optional price id (`price_…`) for catalog reference.
`metadata`	object	Key-value data attached to this item.

An invoice item stays pending until an invoice drains it. A pending item can be updated (POST /v1/invoice_items/{id}) or deleted (DELETE /v1/invoice_items/{id}). Once drained, neither operation is allowed.

Create a draft invoice

const invoice = await ionic.invoices.create({
  "Idempotency-Key": "inv_feb_cus_abc",
  customer: "cus_000000000000000000000000",
  currency: "usd",
  collection_method: "charge_automatically",
});

curl https://api.ionicfi.com/v1/invoices \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "Idempotency-Key: inv_feb_cus_abc" \
  -H "Content-Type: application/json" \
  -d '{
    "customer": "cus_000000000000000000000000",
    "currency": "usd",
    "collection_method": "charge_automatically"
  }'

Field	Type	Notes
`customer`	string	Required. Customer id (`cus_…`).
`currency`	string	Required. Three-letter ISO currency code.
`collection_method`	string	Required. `charge_automatically` charges the customer’s saved card off-session. `send_invoice` generates a hosted invoice for the buyer to pay.
`due_date`	integer	Unix epoch timestamp. Set when using `send_invoice` to express payment terms.
`metadata`	object	Key-value data attached to the invoice.

The created invoice has status: draft and no number. Any pending invoice items for this customer in the given currency are drained onto the draft atomically.

Edit the draft

Add or remove lines while the invoice is a draft. Each call recomputes subtotal and total. Add a line

const line = await ionic.invoices.addLine({
  id: "inv_000000000000000000000000",
  "Idempotency-Key": "line_setup_feb",
  description: "Setup fee",
  quantity: 1,
  unit_amount: 5000,
});

curl -X POST https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/lines \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "Idempotency-Key: line_setup_feb" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Setup fee",
    "quantity": 1,
    "unit_amount": 5000
  }'

Field	Type	Notes
`description`	string	Required. Display label for this line.
`quantity`	integer	Required. Minimum 1.
`unit_amount`	integer	Required. Per-unit price in minor units, in the invoice currency.
`price`	string	Optional price id (`price_…`) for catalog reference.

Remove a line

await ionic.invoices.removeLine({
  id: "inv_000000000000000000000000",
  line_id: "il_000000000000000000000000",
});

curl -X DELETE \
  https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/lines/il_000000000000000000000000 \
  -H "Authorization: Bearer sk_v1_test_..."

Both operations return 422 if the invoice is not a draft.

Finalize

Finalizing transitions the invoice from draft to open. It assigns the next gapless, per-merchant sequential number (INV-000001 in live mode, TEST-INV-000001 in test mode), applies tax, stamps finalized_at, and freezes all lines.

const finalized = await ionic.invoices.finalize({
  id: "inv_000000000000000000000000",
  "Idempotency-Key": "finalize_inv_feb",
  tax: 490,
});

curl -X POST https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/finalize \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "Idempotency-Key: finalize_inv_feb" \
  -H "Content-Type: application/json" \
  -d '{ "tax": 490 }'

Field	Type	Notes
`tax`	integer	Tax amount in minor units. Defaults to 0 when the body is omitted.

A zero-total invoice (all lines sum to zero plus zero tax) transitions directly to paid at finalization. No collection call is needed.

Abandoned drafts never consume a number. The finalized sequence is always contiguous.

Collect payment

charge_automatically

Call POST /v1/invoices/{id}/pay to charge the customer’s saved card off-session. Always include an Idempotency-Key — retrying without one can create a duplicate charge.

const paid = await ionic.invoices.pay({
  id: "inv_000000000000000000000000",
  "Idempotency-Key": "pay_inv_feb_attempt_1",
});

curl -X POST https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/pay \
  -H "Authorization: Bearer sk_v1_test_..." \
  -H "Idempotency-Key: pay_inv_feb_attempt_1"

Response	Meaning
`200`	Invoice is now `paid`.
`402`	Card declined (`PAYMENT_DECLINED`). The decline reason is the `failure_code` on the invoice’s latest payment attempt. See Decline codes.
`422`	Invoice is not open or not `charge_automatically`, or the customer has no payment method on file (`NO_PAYMENT_METHOD`).
`504`	The payment outcome is not known yet. Retrieve the invoice or its payment attempts before retrying.

A 504 does not prove the payment failed. Do not retry with a new Idempotency-Key; the payment may already have been authorized. Retrieve the invoice or its payment attempts, and reuse the same key for the same request.

The invoice’s payment_intent field links to the payment intent created for collection (pi_…). During a dunning retry cycle (the automatic retries after a failed payment), next_payment_attempt_at shows the Unix timestamp of the next scheduled attempt.

send_invoice

When collection_method is send_invoice, Ionic provides a hosted invoice page where the buyer enters their payment details. No server-side pay call is needed; the invoice transitions to paid when the buyer completes payment on the hosted page.

Subscribe to invoice.paid and invoice.payment_failed to handle collection results regardless of how the invoice was paid. See Webhook events. Event delivery can occur shortly after the API response.

Void and write off

Void cancels an open invoice that has taken no payment.

const voided = await ionic.invoices.void({
  id: "inv_000000000000000000000000",
});

curl -X POST https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/void \
  -H "Authorization: Bearer sk_v1_test_..."

Mark uncollectible writes off an open invoice as bad debt. The outstanding balance is retained for reporting.

const uncollectible = await ionic.invoices.markUncollectible({
  id: "inv_000000000000000000000000",
});

curl -X POST https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/mark_uncollectible \
  -H "Authorization: Bearer sk_v1_test_..."

Both operations return 422 if the invoice is not in open status.

Invoice statuses

Status	Meaning
`draft`	Editable. Lines can be added or removed. No number assigned.
`open`	Finalized and awaiting payment.
`paid`	Payment collected in full.
`void`	Cancelled before any payment was taken.
`uncollectible`	Written off. Outstanding balance retained for reporting.

Payment attempts

Retrieve an invoice’s payment attempts, newest first. Use this history to show each attempt and its result.

const attempts = await ionic.invoices.listPaymentAttempts({
  id: "inv_000000000000000000000000",
});

curl https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000/payment_attempts \
  -H "Authorization: Bearer sk_v1_test_..."

Each attempt has a status of pending, succeeded, failed, or blocked, and a failure_code when the card was declined or blocked. pending means the final result is not known yet; retrieve the attempts again before retrying.

Retrieve and list

const retrieved = await ionic.invoices.retrieve({
  id: "inv_000000000000000000000000",
});

curl https://api.ionicfi.com/v1/invoices/inv_000000000000000000000000 \
  -H "Authorization: Bearer sk_v1_test_..."

const invoices = await ionic.invoices.list({
  customer: "cus_000000000000000000000000",
  status: "open",
  limit: 20,
});

curl "https://api.ionicfi.com/v1/invoices?customer=cus_000000000000000000000000&status=open&limit=20" \
  -H "Authorization: Bearer sk_v1_test_..."

The list endpoint accepts customer, subscription, status, limit (default 20, max 100), and offset.

Invoices for connected merchants

A platform creates and manages invoices for a connected merchant with its platform secret key. Send the merchant ID in the Ionic-Account header, or pass the account request option to the server SDK (@ionicfi/sdk 0.4.4 or later). The invoice belongs to that merchant.

const invoice = await ionic.invoices.create(
  {
    "Idempotency-Key": "merchant:mer_BBBBBBBBBBBBBB:invoice:order_123",
    customer: "cus_000000000000000000000000",
    currency: "usd",
    collection_method: "send_invoice",
  },
  { account: "mer_BBBBBBBBBBBBBB" },
);

The platform key and the merchant’s connection must both grant invoices:write. Reading invoices and downloading PDFs need invoices:read.
The customer, payment method, and any price must belong to the selected merchant in the same mode. An object from another merchant returns 404.
Every write returns 403 MERCHANT_INACTIVE while the merchant is not active.
Collecting payment with POST /v1/invoices/{id}/pay and changing the card it charges with POST /v1/invoices/{id}/payment_method also need the merchant to be ready to take payments in that mode. Until then they return 403 PAYMENTS_NOT_ENABLED (403 LIVE_PAYMENTS_NOT_ENABLED in live mode), or 422 account_not_yet_active or 422 account_activation_failed while the merchant’s payment account is being set up. Other invoice and invoice item writes, including void, don’t need payments to be ready.

Best practices

Always send an Idempotency-Key on POST /v1/invoices/{id}/pay. A network timeout leaves the charge state ambiguous — retrying with the same key is safe; retrying without one risks a duplicate.
Distinguish 402 from 504 before deciding what to do next. A 402 is a definitive decline and requires a new payment method. A 504 means the outcome is unknown and will resolve on its own.
Use GET /v1/invoices/{id}/payment_attempts to show each collection try with its outcome and failure code.
Store your order or billing ID in metadata when creating the invoice so you can match it to records in your own system.
Record metered or usage-based charges as invoice items throughout the billing period. When the billing cycle closes, create one invoice per customer and currency — the pending items drain automatically.
An invoice item or line that names a price must use a price owned by the same account in the same mode. Any other price returns 404 PRICE_NOT_FOUND.
A 409 from any mutating endpoint means the invoice was modified concurrently. The request can be retried as-is.

What’s next

Adjust a paid invoice

Preview and issue a credit note against a paid invoice.

Bill on a schedule

Let Ionic issue a renewal invoice each period.

Handle invoice events

React to payment, failure, and write-off events.

​Lifecycle

​Record pending charges

​Create a draft invoice

​Edit the draft

​Finalize

​Collect payment

​charge_automatically

​send_invoice

​Void and write off

​Invoice statuses

​Payment attempts

​Retrieve and list

​Invoices for connected merchants

​Best practices

​What’s next

Adjust a paid invoice

Bill on a schedule

Handle invoice events

Lifecycle

Record pending charges

Create a draft invoice

Edit the draft

Finalize

Collect payment

charge_automatically

send_invoice

Void and write off

Invoice statuses

Payment attempts

Retrieve and list

Invoices for connected merchants

Best practices

What’s next