Skip to main content

Addon Configuration

ParameterTypeDefaultDescription
License KeystringInput the license key you received from us.
Production API Client IDstringProduction API client identifier.
Production API Client SecretstringProduction API client secret.
Production Organisation IDstringTo get the production credentials, follow the instructions in the “Pingen Account Configuration” chapter.
Staging API Client IDstringStaging API client identifier.
Staging API Client SecretstringStaging API client secret.
Staging Organisation IDstringTo get the staging credentials, follow the instructions in the “Pingen Account Configuration” chapter.
EnvironmentradioStagingRecommended to try Staging first (no letters sent, no costs). Switch to Production once verified.
Default Sending SpeedradioEconomyPriority mail is faster and more expensive than Economy.
Default Sending ColorradioGrayscaleBlack and white prints are cheaper; color prints look nicer.
Default Printing ModeradioSimplexIndicates if printing should be Simplex or Duplex.
Default Address PositionradioLeftIndicates if the recipient address is on the left or right side of the PDF invoice.
Sending moderadioManualModes: Manual (explicit send), Clients (only if enabled), Automatic (always send unless disabled).
Enable Client AreacheckboxnoAllows clients to enable/disable sending invoices with Pingen from the Client Area. Requires Sending Mode set to Clients or Automatic.
TriggerradioOnOrderAcceptChoose whether to send on invoice creation or when the order is accepted. Invoices without orders (e.g., renewals) are sent on creation.
Payment Gateways RestrictionstringComma-separated list of WHMCS payment gateway module names (e.g., paypal,checkout). Empty = applies to all gateways.
Invoice Product Addon IDnumericOnly send if invoice contains the addon with the configured ID. Empty = no restriction.
Add fee on invoice creationcheckboxnoApply the price of the configured addon as a fee on each new invoice. Product addon must be hidden and one-time priced. Recommended with Send Mode = Clients and Client Area enabled.
Send when zerocheckboxnoAlso send when invoice balance is <= 0.
First overduecheckboxnoAlso send when first overdue notice is due.
Second overduecheckboxnoAlso send when second overdue notice is due.
Third overduecheckboxnoAlso send when third overdue notice is due.
Late feecheckboxyesResend when late fee is added to invoice.
Abort e-mailscheckboxyesDon’t send e-mails to clients when invoice is sent via Pingen.
Notify adminscheckboxyesNotify WHMCS administrators when an invoice has been automatically sent via Pingen.
Absolute storage pathstringMust be an absolute path to a writable directory not accessible from the web. Used as temporary storage while sending files.
Access controlcheckboxesEnsure addon access is granted to appropriate staff groups.