Skip to main content

​
Hyperline test mode

Setting up billing often requires experimentation. Use test mode, also called sandbox, to test Hyperline without affecting your production account. When you switch to test mode, Hyperline creates a separate test account. You can create test customers, subscriptions, invoices, usage events, and payments before configuring production billing.
Test mode does not block outbound emails. If an action normally sends an email in production, Hyperline also sends it from your test account to the configured recipient, such as a customer email, invoice email, checkout recipient, quote recipient, or additional email recipient. Use internal or dedicated test email addresses for sandbox customers and recipients unless you intentionally want a real recipient to receive the message.
Test mode has the same product capabilities as your production account. Use the product documentation to configure your product catalog, manage templates, send invoices, use credits and wallets, and more. You can also manage your team from inside sandbox. Invite members, revoke access, merge duplicate members, and transfer ownership all work the same way in sandbox as in production. See Users & permissions for the steps.

​
Switching between production and sandbox

Access to sandbox is controlled by a single permission, test mode read:
  • To enter sandbox from production, a member needs the test mode read permission on their role.
  • To switch back from sandbox to production, no extra permission is required. Any member already in sandbox can return to production, and access to production data is enforced server-side by their production role.
Grant test mode read to any role whose members should be able to open sandbox from the account switcher.

​
Testing payments

Test payment provider and gateway flows in sandbox before connecting production bank accounts or production payment provider accounts. Sandbox payments use sandbox payment provider accounts, so no real money is charged or debited. If your sandbox account was populated from production data or from another billing system, existing production payment methods cannot be used in sandbox. Production cards, mandates, and bank authorizations are not compatible with sandbox payment provider accounts.

​
Add a test payment method

To test automatic payments, add a test payment method to the sandbox customer from a hosted page:
  1. Open a sandbox hosted page for the customer, such as a quote signature page, checkout page, invoice page, or customer portal.
  2. Go to the Add payment method section.
  3. Enter test payment details from your payment provider.
Use the provider’s test credentials: Once a test payment method has been added, future invoices can be charged automatically with that payment method. To test payment collection on an existing invoice, open the invoice and click Actions > Charge invoice.

​
Simulate usage data without code

This applies if you want to configure your first usage-based plan and assign a subscription to a customer in order to test Hyperline. In the test account, you can simulate usage data by generating fake events for a specific customer. This is done in two steps:
1

Go to one of your customers from the Customer section

Then click the Events tab, and click Simulate new events.
2

Fill in the Event type field with the event name used to aggregate usage in your billing plan configuration.

Fill in:
  • The event type (API calls, email sent, document retrieved or created, etc.)
  • The date (leave blank if you prefer)
  • The number of events to create
  • You can optionally add extra parameters to your event with the JSON Payload field.
Click Create new events when you are ready.The events can take a few seconds to be ingested.They will appear in your customer’s Events page.You can easily delete them in the Events page afterward.
You are done. You can now create your first usage-based plan based on these events.

​
Multiple accounts

If you belong to several Hyperline accounts, use the account switcher to move between them without signing out. Each account has its own settings, members, permissions, customers, catalog, billing data, and integrations. You can therefore use separate accounts for different companies or legal entities that require fully independent configurations. Members and roles are managed separately for each account. See Users & permissions for details.