Invoices

Retrieve and manage invoices through the Invoices API.

Get All Invoices

Retrieve a list of all invoices for your account.

Endpoint

GET https://api.audian.com:8443/v2/billing/invoices

Parameters

Parameter	Type	Required	Description
`status`	string	No	Filter by status (draft, issued, paid, overdue)
`limit`	integer	No	Maximum results (default: 20, max: 100)
`offset`	integer	No	Pagination offset
`start_date`	string	No	Filter by date range (ISO 8601)
`end_date`	string	No	Filter by date range (ISO 8601)

Request Example

curl -X GET 'https://api.audian.com:8443/v2/billing/invoices?status=paid&limit=20' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "invoices": [
      {
        "id": "inv_abc123",
        "invoice_number": "2024-001",
        "issue_date": "2024-02-01T00:00:00Z",
        "due_date": "2024-03-02T00:00:00Z",
        "period_start": "2024-01-01T00:00:00Z",
        "period_end": "2024-01-31T23:59:59Z",
        "amount": 150.75,
        "currency": "USD",
        "status": "paid",
        "paid_at": "2024-02-15T10:30:00Z"
      },
      {
        "id": "inv_abc124",
        "invoice_number": "2024-002",
        "issue_date": "2024-03-01T00:00:00Z",
        "due_date": "2024-04-01T00:00:00Z",
        "period_start": "2024-02-01T00:00:00Z",
        "period_end": "2024-02-29T23:59:59Z",
        "amount": 175.50,
        "currency": "USD",
        "status": "paid",
        "paid_at": "2024-03-15T10:30:00Z"
      }
    ],
    "total": 45,
    "limit": 20,
    "offset": 0
  }
}

Get Specific Invoice

Retrieve details for a specific invoice.

Endpoint

GET https://api.audian.com:8443/v2/billing/invoices/{invoice_id}

Request Example

curl -X GET 'https://api.audian.com:8443/v2/billing/invoices/inv_abc123' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "id": "inv_abc123",
    "invoice_number": "2024-001",
    "issue_date": "2024-02-01T00:00:00Z",
    "due_date": "2024-03-02T00:00:00Z",
    "period_start": "2024-01-01T00:00:00Z",
    "period_end": "2024-01-31T23:59:59Z",
    "status": "paid",
    "paid_at": "2024-02-15T10:30:00Z",
    "customer": {
      "id": "cust_abc123",
      "name": "Acme Corporation",
      "email": "billing@acme.com"
    },
    "line_items": [
      {
        "description": "Phone Numbers (10 x $0.99/month)",
        "quantity": 10,
        "unit_price": 0.99,
        "amount": 9.90
      },
      {
        "description": "SMS Messages (1234 x $0.01)",
        "quantity": 1234,
        "unit_price": 0.01,
        "amount": 12.34
      },
      {
        "description": "Voice Minutes (456 x $0.02)",
        "quantity": 456,
        "unit_price": 0.02,
        "amount": 9.12
      },
      {
        "description": "Voicemail Transcriptions (8 x $0.25)",
        "quantity": 8,
        "unit_price": 0.25,
        "amount": 2.00
      }
    ],
    "subtotal": 33.36,
    "taxes": 2.67,
    "total": 36.03,
    "amount_paid": 36.03,
    "amount_due": 0.00,
    "currency": "USD",
    "payment_method": "visa_****1234",
    "notes": ""
  }
}

Download Invoice PDF

Download an invoice as a PDF file.

Endpoint

GET https://api.audian.com:8443/v2/billing/invoices/{invoice_id}/pdf

Request Example

curl -X GET 'https://api.audian.com:8443/v2/billing/invoices/inv_abc123/pdf' \
  -H 'X-Auth-Token: YOUR_API_KEY' \
  -o invoice_2024_001.pdf

The response will be a PDF file with:

Invoice header with Audian branding
Itemized charges
Payment terms
Payment method used
Total amount owed

Invoice Statuses

Status	Description
`draft`	Invoice is being prepared (not yet issued)
`issued`	Invoice has been issued and is awaiting payment
`paid`	Invoice has been paid in full
`partial`	Invoice has been partially paid
`overdue`	Invoice payment is overdue
`cancelled`	Invoice has been cancelled
`refunded`	Invoice has been refunded

Invoice Line Items

Each invoice contains line items detailing charges:

Common Line Items

Item	Description
Phone Numbers	Monthly rental fees for owned numbers
SMS Messages	Outbound SMS charges
Voice Minutes	Outbound voice call charges
Voicemail Transcriptions	Automatic voicemail-to-text charges
Number Porting	One-time porting fees
Feature Overages	Additional fees for exceeded limits

Invoice Dates

Issue Date: When the invoice is generated (first of month)
Due Date: Payment deadline (typically 30 days)
Period Start: Start of billing cycle
Period End: End of billing cycle
Paid Date: When payment was received

Get Recent Invoices

Retrieve the most recent invoices.

Request Example

curl -X GET 'https://api.audian.com:8443/v2/billing/invoices?limit=5&offset=0' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Search Invoices

Filter invoices by various criteria.

Request Example

# Get paid invoices from Q1 2024
curl -X GET 'https://api.audian.com:8443/v2/billing/invoices?status=paid&start_date=2024-01-01&end_date=2024-03-31' \
  -H 'X-Auth-Token: YOUR_API_KEY'

Invoice Archive

Keep invoices for your records:

Store PDFs in cloud storage (Google Drive, Dropbox, etc.)
Archive receipts for accounting purposes
Keep for at least 7 years for tax purposes

Payment Information

Payment Status

From the invoice response, check:

status: Current invoice status
amount_paid: Amount already paid
amount_due: Remaining balance
paid_at: When full payment was received

Late Payment

If an invoice is overdue:

You'll receive email reminders
Your account access may be restricted
Late fees may apply (varies by agreement)

Troubleshooting

Issue	Solution
Invoice not found	Check invoice ID or date range
Missing PDF	Ensure invoice status is not "draft"
Wrong amount	Compare to usage API for details
Payment not reflected	May take 24-48 hours to process

Best Practices

Download Regularly: Download invoices as they're issued
Verify Charges: Compare to usage data
Keep Records: Archive invoices for accounting
Set Reminders: Don't miss payment deadlines
Review Trends: Monitor costs month-to-month

FAQ

Q: When will my invoice be available? A: Invoices are issued on the first business day of the month.

Q: Can I get an invoice for a custom period? A: Contact support for custom invoicing needs.

Q: How long are invoices retained? A: Invoices are available for 7 years on your account.

Q: What payment methods do you accept? A: Credit cards, ACH transfers, and wire transfers.

Q: Can I dispute a charge on an invoice? A: Yes, contact support within 30 days with details.

Get All Invoices​

Endpoint​

Parameters​

Request Example​

Response​

Get Specific Invoice​

Endpoint​

Request Example​

Response​

Download Invoice PDF​

Endpoint​

Request Example​

Invoice Statuses​

Invoice Line Items​

Common Line Items​

Invoice Dates​

Get Recent Invoices​

Request Example​

Search Invoices​

Request Example​

Invoice Archive​

Payment Information​

Payment Status​

Late Payment​

Troubleshooting​

Best Practices​

FAQ​

Get All Invoices

Endpoint

Parameters

Request Example

Response

Get Specific Invoice

Endpoint

Request Example

Response

Download Invoice PDF

Endpoint

Request Example

Invoice Statuses

Invoice Line Items

Common Line Items

Invoice Dates

Get Recent Invoices

Request Example

Search Invoices

Request Example

Invoice Archive

Payment Information

Payment Status

Late Payment

Troubleshooting

Best Practices

FAQ