list-overdue-invoices

List Overdue Invoices

List open and overdue invoices in Alternative Payments, segment them by how far past due they are, and optionally generate a hosted payment link for each so the customer can choose to pay. This command never charges a customer — it only reads invoices and, when asked, produces hosted payment-link URLs.

Prerequisites

• Valid Alternative Payments OAuth2 credentials configured (AP_CLIENT_ID, AP_CLIENT_SECRET)
• Environment selected (AP_ENVIRONMENT = production or demo)
• Scope payments:read (plus payments:write only if with_links is used)

Steps

1. Authenticate with Alternative Payments

   BASE=https://public-api.alternativepayments.io
   TOKEN=$(curl -s -X POST "${BASE}/oauth/token" \
     -u "${AP_CLIENT_ID}:${AP_CLIENT_SECRET}" \
     -H "Content-Type: application/x-www-form-urlencoded" \
     -d "grant_type=client_credentials" \
     | jq -r '.access_token')
   

2. List invoices (cursor-paginated)

   curl -s "${BASE}/invoices?limit=100" \
     -H "Authorization: Bearer ${TOKEN}"
   

   Loop on has_more / next_cursor, passing after=<cursor> for each page. If customer_id is supplied, filter the results to that customer.

3. Separate overdue from open

   • Keep invoices with status of overdue (and open when include_open is true)
   • Compute days past due_date for each overdue invoice

4. Segment by aging — current, 1–30, 31–60, 61–90, 90+ days past due

5. (Optional) Generate hosted payment links when with_links is true

   curl -s "${BASE}/invoices/${INVOICE_ID}/payment-link" \
     -H "Authorization: Bearer ${TOKEN}"
   

   This returns a URL the customer visits to pay. No money moves until the customer completes payment.

6. Format and return the summary

Parameters