Skip to main content

​
Share the invoice and customer portal

Orb generates a signed, expiring URL to an invoice portal and a signed, non-expiring URL to a customer portal. By default, the invoice portal link expires 30 days after the invoice’s due date. These portals can be directly accessed by your customers and are symmetrical to the internal version of the Orb invoice and a full view of a customer’s invoices and current usage respectively, reflecting Orb’s philosophy around transparency in the customer relationship. These portals can serve as an out-of-the-box tool for displaying a complete view of the upcoming bill for your customer and the history of all invoices alongside their payment status. There are multiple ways to integrate this information in your app:
  1. You can directly embed the invoice portal for an individual invoice using an iFrame in your application.
  2. You can extract details from the invoice resource programmatically and build a custom experience on top of the invoice data. Orb also exposes the cost and usage APIs for the day by day graphs for each metric in the plan.
  3. The invoice resource, and customer resources with permanent portal links enabled, expose the signed resource link directly, allowing you to link to the Orb-hosted portals from your app.
Invoice portal

​
Customer portal sessions

For customer portal access, Orb also supports short-lived portal session URLs. Use POST /v1/customers/{customer_id}/portal_sessions to create a session URL that expires after expires_in_minutes (60 minutes by default, with a maximum of 180 minutes). By default, creating a new portal session invalidates any other active portal sessions for that customer. If you need multiple concurrent session URLs, for example when minting links for several authenticated end users, set invalidate_existing to false. Creating a portal session does not invalidate the customer’s permanent portal link. Accounts can enable a Customer portal sessions only setting in Invoice Settings. When enabled, new customers do not receive permanent customer portal URLs, and the portal_url field on the customer resource returns null. Existing permanent links continue to work. This setting is one-way and cannot be disabled after it is enabled.

​
Portal payments

The invoice and customer portal embed a form from the payment gateway that allows your user to pay invoices manually. This payment option can be configured to optionally save the payment method to the customer, and can be restricted to specific payment types (e.g. configuring invoices to only be payable via ACH). Customer portal By default, the signed link for the invoice portal expires 30 days after the invoice due date and is delivered to your customers in the invoice email (see Email delivery). This link can be refreshed at any time through the portal or revoked for any reason, which will be valid for 60 days. A single link can be active for an invoice at a time. Revoke link