PaperTiger.Resources.InvoiceItem (PaperTiger v0.9.20)

Handles InvoiceItem resource endpoints.

Endpoints

POST /v1/invoiceitems - Create invoice item
GET /v1/invoiceitems/:id - Retrieve invoice item
POST /v1/invoiceitems/:id - Update invoice item
DELETE /v1/invoiceitems/:id - Delete invoice item
GET /v1/invoiceitems - List invoice items

InvoiceItem Object

%{
  id: "ii_...",
  object: "invoiceitem",
  created: 1234567890,
  customer: "cus_...",
  invoice: "in_..." | nil,
  amount: 2000,
  currency: "usd",
  description: "Premium Plan",
  quantity: 1,
  metadata: %{},
  # ... other fields
}

Summary

Functions

create(conn)

Creates a new invoice item.

delete(conn, id)

Deletes an invoice item.

list(conn)

Lists all invoice items with pagination.

retrieve(conn, id)

Retrieves an invoice item by ID.

update(conn, id)

Updates an invoice item.

Functions

create(conn)

@spec create(Plug.Conn.t()) :: Plug.Conn.t()

Creates a new invoice item.

Required Parameters

customer - Customer ID
amount - Amount in cents (integer)
currency - Three-letter ISO currency code (e.g., "usd")

Optional Parameters

invoice - Invoice ID (optional until invoice is finalized)
description - Item description
quantity - Quantity (default: 1)
metadata - Key-value metadata

delete(conn, id)

@spec delete(Plug.Conn.t(), String.t()) :: Plug.Conn.t()

Deletes an invoice item.

Note: Invoice items can only be deleted if not part of a finalized invoice.

Returns a deletion confirmation object.