Organization API: Customer Portal: Invoices

Part of Customer Portal.

GET /api/v1/orgs/{org_slug}/portal/invoices

Newest first, ties by id. with_total wraps the page as {items, total, limit, offset, counts}; counts are per status for the same search, whatever the status filter.

GET /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/apply-credit

Apply the customer's credit balance toward an unpaid invoice.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/charge

Pay an invoice using a saved payment method (merchant-initiated charge). If no payment_method_id specified, uses the default method.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/checkout

Canonical hosted checkout for an org-customer invoice (alias of /pay).

GET /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/checkout-session

Resume an in-flight checkout after a new tab, login, or API restart.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/confirm-payment

Finalize a charge after customer completes SCA (3-D Secure). Retrieves the PaymentIntent from Stripe and settles the org invoice on success.

GET /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/gateways

Gateway accounts that can checkout this invoice's pay currency.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/pay

Hosted checkout for an invoice (legacy path; prefer /checkout). Creates a hosted checkout session and returns an approval URL.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/pay-intent

Create an in-page Stripe Payment Element intent for an org invoice.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/paypal-capture

Finalize an embedded PayPal Buttons one-off payment: capture the buyer-approved order server-side and apply it to the org invoice (USD ledger). Idempotent via the gateway_reference uniqueness in settle_org_invoice_payment.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/paypal-stash

Persist a PayPal order id so a redirect or reboot can still capture it.

GET /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/pdf

The invoice as a document to keep. Statements are staff-facing; this is the copy a customer files with their own accounts.

GET /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/refund-eligibility

What the Refund Policy says about this invoice, so the page can offer the request, or say plainly why it cannot, before the customer types.

POST /api/v1/orgs/{org_slug}/portal/invoices/{invoice_id}/refund-request

application/json (required)

Type: Body.