Auto Top-up Profiles
An auto top-up profile defines when and how a customer’s balance is topped up automatically, and the follow-up actions that run afterwards. See the Auto Top-up Profiles guide for the full picture.
Methods
Section titled “Methods”Retrieve Single Auto Top-up Profile
Section titled “Retrieve Single Auto Top-up Profile”/backend/api/v1/autoTopupProfiles/ID - fetch the profile with the specified ID.
List Auto Top-up Profiles
Section titled “List Auto Top-up Profiles”/backend/api/v1/autoTopupProfiles/ - list all profiles.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include profiles with a higher ID |
createdSince | datetime | No | Only include profiles created since the given time |
updatedSince | datetime | No | Only include profiles updated since the given time |
/backend/api/v1/autoTopupProfiles/ - add a new profile. The newly-added profile will be returned.
/backend/api/v1/autoTopupProfiles/ID - update the profile with the specified ID. The modified profile will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/autoTopupProfiles/ID - delete the profile with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | Auto Topup Profile Name | Text | Display name shown in lists and on the customer. |
| description | Description | Text | Optional description of when to use this profile. |
| enabled | Enabled | Text | Only enabled profiles are applied to customers. |
| triggerBasis | Trigger Basis | Preset Value | Which balance to compare against the threshold: Outstanding, Overdue, or Unbilled Calls (approximation until invoiced). |
| triggerType | Threshold Type | Preset Value | Absolute Amount is offset from the selected Reference Limit; Percent of Limit uses that limit as the 100% basis. |
| triggerValue | Threshold Value | Currency | For Absolute Amount, the threshold is (Reference Limit − this value). |
| referenceLimit | Reference Limit | Preset Value | Limit used when calculating the trigger threshold (and the Topup Reference Limit when applicable). |
| topupMode | Topup Mode | Preset Value | Fixed Amount adds a specific monetary amount. To Percent Of Limit tops up to reach the chosen percentage of the selected limit. |
| topupValue | Topup Value | Currency | Amount to add (Fixed Amount) or target percentage (To Percent Of Limit). Customer-level autoTopupAmount overrides this with a fixed amount. |
| topupReferenceLimit | Topup Reference Limit | Preset Value | Limit used when Topup Mode = To Percent Of Limit. Defaults to Reference Limit when not set. |
| autoCollect | Auto-Collect Payment | Preset Value | When Yes, create a Payment if the customer’s payment method allows automatic collection. |
| correspondenceTypeExpected | Correspondence: EP Only | Preset Value | Correspondence to create when only an Expected Payment is created. |
| correspondenceTypeCard | Correspondence: Card Payment | Preset Value | Correspondence to create when a Payment Card payment is created. |
| correspondenceTypeDirectDebit | Correspondence: Direct Debit Payment | Preset Value | Correspondence to create when a Direct Debit payment is created. |
| minDaysBetweenTopups | Min Days Between Topups | Number | Cooldown window based on Expected Payment creation date. 0 means evaluate every day. |
| customerID | Customer | Text | Optional: restrict this profile to a single customer. |
| id | Auto Topup Profile ID | Text |