aimldocs
Console

Credits

See your balance, top up, set up auto top-up, redeem and gift codes, ask for refunds, change plan and read the ledger.

The Credits screen is where money enters and leaves your organization's balance. Everyone in the organization can open it and read it. Changing anything on it (topping up, mandates, codes, gifts, refunds, plans) needs the owner, admin or billing role; for other roles the buttons are disabled and their tooltip says why.

How credits, holds, rounding and tax work is explained in Billing basics. This page covers what you can do on the screen.

Amounts are shown in your billing currency, or in the display currency you picked in the top bar. Hover over an amount for the exact figure.

Balance

The Balance panel shows:

  • Available: what you can spend now.
  • Held: credit reserved by requests that are still running. It returns to available, less the real cost, when each request finishes.
  • Promotional, expiring: shown only when you hold promotional credit with an expiry. Under it you see how much expires next and when. Promotional credit is spent first, soonest to expire first, and what is left at its expiry is taken back. Paid credit never expires.

A chip reading "as of" with a time appears next to a figure that is more than a minute old.

Your contract

If your organization has negotiated terms with us, a Your contract panel shows them: the discount, the spend you committed to each month, and the date they start. It appears only when you have a contract, and the terms are changed by us, not on this screen.

  • Requests are charged at list price, like everyone's.
  • When a month closes, the discount on what you spent that month is added to your balance as one credit. If you are on a credit line, it is taken off that month's invoice instead.
  • The table lists each closed month: what you spent, the discount, and how it was given.

A month is closed about six hours after it ends, so the last requests of the month are counted.

Top up

The first time, an organization with no billing country sees Where are you billed? in place of the Top up panel. Choose the country (the console suggests your browser's), and for India enter your GSTIN (optional), then press Continue to add credit. The country sets your currency and the tax on your invoices, and you can change it until your first invoice. Registering a mandate and changing plan ask for it the same way. Only an owner or admin can set it.

  1. In the Top up panel, choose one of the preset amounts or type one in the Custom amount box. The amount is in your billing currency.
  2. Read the quote that appears. It shows the Credits the amount buys, the GST line when tax applies, and the total Charged at checkout. Below it are the payment rail, its processing fees, and the exchange rate with the day it was booked. For an organization outside India the quote says the supply is a zero-rated export and that an export invoice is issued. While your first payment is settling, top-ups are limited, and the quote states the limit and when it lifts.
  3. When more than one payment provider can take your payment, Pay through lists them: Card (Stripe) and UPI, cards, netbanking (Razorpay). Each shows its processing fee, from the cheapest method to the dearest, and what you pay. The fee is taken from the credits you buy, so you pay the same total either way. The usual one for your billing country is chosen to start with: Razorpay for India, Stripe elsewhere. Razorpay takes rupees only, so an organization billed in another currency pays through Stripe and sees no choice. Your browser remembers the one you chose last.
  4. If you pay through Stripe in a currency other than rupees, Pay with lets you choose Card, Link and more (the default), Alipay or WeChat Pay. Choosing Alipay or WeChat Pay makes the checkout offer only that method.
  5. Press Proceed to checkout. You are sent to the payment provider's hosted page.

Whichever provider you pay through, the tax invoice for the payment is the same, in your billing currency.

When you come back, a panel at the top of the screen follows the payment. It checks every 2 seconds and shows one of:

  • Top-up confirmed, with the credit added, any processing fee that was passed through, and a See the invoice, which opens the Invoices screen link.
  • The payment failed at the gateway, with a Try again button.
  • After 10 minutes without a confirmation, a note that the credit will arrive when the payment provider notifies us if you were charged, with a contact support link and the top-up reference to quote.

The button stays disabled until the quote has loaded.

If you buy through a reseller

Some resellers take their customers' payments themselves. If yours does, the Top up panel quotes in the reseller's currency and with the reseller's tax (VAT, for example, or GST), shows any surcharge the reseller adds as its own line, and says that you pay the reseller directly and that the reseller issues the tax invoice. Pay with is not offered: the checkout is the reseller's own.

After you pay, the reseller's prepaid balance funds your credit. If that balance is short at the moment you pay, the panel shows Payment received, credit pending: the reseller has your money, and the credit is added as soon as the reseller's balance allows, without you doing anything. You do not need to pay again. While any payment waits, the same notice stays at the top of the Credits screen with each payment, what you paid and the credit it buys. Refunds of these payments are the reseller's to make; ask the reseller.

Low-balance alerts

Once you have paid for credit, the owners and admins of your organization are told by e-mail, and any webhook subscribed to credits.low or credits.exhausted is called, as the balance runs down:

  • at 25% of your last top-up (credits.low, level low);
  • at 5% (credits.low, level critical), with a link to set up auto top-up if it is off;
  • at zero (credits.exhausted), after which requests are refused until you add credit.

Each alert is sent once per fall. After the balance goes back above a level, a later fall is announced again. The Dashboard shows the same alerts. Promotional credit alone does not trigger them, and an organization on a credit line gets invoice reminders instead.

Auto top-up and mandates

Auto top-up charges a payment mandate when your balance falls below a threshold you set. You register the mandate once, then switch auto top-up on.

Register a mandate

  1. In the Auto top-up panel, choose a Method. The list depends on your billing country and can include UPI AutoPay, e-mandate (net banking / debit card) and Saved card.
  2. Press Register mandate. You are sent to the bank or payment provider to authorise it.
  3. When you return, a note says the registration came back from the bank. The mandate line shows a status badge, the method, the payment provider and the cap per debit. It changes to active when the provider confirms, usually within a minute; UPI AutoPay can take longer.

If you left the authorisation unfinished, the mandate stays pending and the panel shows a continue registration link. While a mandate is not active you can also press Register a new mandate to start again.

Switch auto top-up on

Once the mandate is active:

  1. Tick Enable auto top-up.
  2. Set When balance falls below (USD).
  3. Set Top up by, in your billing currency. Where GST applies, the panel shows what each debit comes to with tax. The amount plus tax must fit the mandate's cap; if it does not, the field says so and Save is disabled. There is also a minimum amount, shown in the button's tooltip when you are below it.
  4. Press Save. The panel confirms with "Auto top-up saved".

The panel states the cap per debit and how many hours ahead each debit is announced. For UPI AutoPay and saved cards the cap is the most a debit can take without extra authentication. For a bank e-mandate it is the maximum registered with the bank. When a debit is scheduled, an amber note shows the amount and time and says a pre-debit notice was sent. The debit is skipped if your balance recovers first. Last auto top-up shows the status, amount and time of the most recent one, with the reason if it failed. Three failed debits in a row switch auto top-up off.

Cancel a mandate

Press Cancel mandate, type cancel in the confirmation and confirm. Auto top-up stops. You can register a new mandate at any time.

Daily check-in

This panel appears only when the reward is switched on for your installation, so you may not see it. When it is shown, it states how much credit a check-in gives and for how many days that credit can be used, and your current streak.

Press Check in once per day. Days are counted in UTC. After that the button reads Checked in today until the next day. The reward is promotional credit: it appears under Promotional, expiring and is spent before paid credit.

Redeem a code

  1. In Redeem a code, type or paste the code into the box.
  2. Press Redeem.

Capitals, spaces and dashes in the code do not matter. On success the panel says how much was added and from which promotion, and when unused credit from it expires if the promotion sets an expiry. Codes you have redeemed are listed below the box with their amount and time. The same box redeems a gift code another organization gave you.

If the code is refused, the error says why: for example it is not valid, has expired, was revoked, is used up, or your organization already redeemed one from the same promotion. Too many refused attempts in an hour pause redemption for that hour.

Gift credit

A gift moves some of your paid credit into a code that another organization can redeem.

  1. In Gift credit, enter the Amount (USD). A gift can be at most $500.
  2. Optionally add a Note (only you see it).
  3. Press Create gift.

The gift code is shown once, in a panel at the top of the section. Copy it, tick I have stored it and press Done. It cannot be shown again; the table afterwards shows only the last characters of the code.

The amount leaves your balance at once. It comes back if the gift is not redeemed in 90 days, or when you cancel it. Promotional credit cannot be gifted. The rules on who may create a gift are in Billing basics; if you do not meet them, the error says which one.

The table lists each gift with its Code ending, Amount, Note, Status (open, redeemed, cancelled or returned) and, for an open gift, the time under Returns if unredeemed.

To cancel an open gift, press Cancel on its row, type the code ending shown in the confirmation and press Cancel gift. Its credit returns to your balance.

Plan

The Plan section shows your current plan with its status and period, and a card for each plan with its monthly fee, included credits and limits.

  • Upgrade now appears on a plan that costs more than yours. It applies immediately and is prorated to the remaining whole days of the month. The fee difference is taken from your balance and the extra included credits are added at once. A green line confirms the charge and the credits added, with a link to the plan invoice.
  • Switch at period end appears on a plan that costs less. Nothing is charged now. A chip next to your current plan says which plan it switches to at the period end.
  • Keep this plan appears on your current plan when a switch is scheduled. Pressing it cancels the scheduled switch.

If a renewal could not be taken from your balance, the plan shows past_due with an explanation. Either the fee is being charged to your auto top-up mandate, with the time of the next attempt and the last error if there was one, or you are asked to top up within 7 days, after which the organization returns to pay as you go.

For invoicing against a purchase order on net terms, write to the support address shown under the plans.

Refunds

Unused credit goes back to the payment that funded it. The tax is returned with it and a credit note is issued. The processing fee is not refunded. The section shows how much credit is available now.

  1. Under Refunds, choose the Top-up to refund. Only paid top-ups are listed.
  2. Enter an Amount in your billing currency, or leave it blank to refund everything still refundable on that top-up. The field label shows that figure.
  3. Optionally give a Reason.
  4. Press Request refund.

A confirmation line shows the refund's status, the total sent to the payment with its tax, the credit removed from your balance and a link to the credit note PDF. Past refunds are listed below with their status, amount, reason, time and credit note. Older refunds loads earlier ones.

If you have no paid top-ups, the section reads "Nothing to refund".

Invoices

The Invoices section lists your ten most recent documents with number, kind, total, date and a PDF link. All invoices opens the full Invoices screen.

Ledger

The Ledger is the record of every change to your balance, newest first.

  • Kind filters the list to one kind of entry, such as topup, settle, grant, plan_fee, plan_credit, refund, adjust, expire, gift, commission, payout, transfer or margin_share.
  • Export CSV downloads the entries, with the kind filter applied.
  • Daily reconciliation opens the reconciliation report.

Each row shows the Time, the Kind, the Amount, a Reference and the Balance after: your total balance, available plus held, once that entry was booked. The newest row stands at your current total, and the figure stays correct as you page back. When the entry is the charge for a request, the reference is the request id and links to the request detail. Older entries loads the next page. With a Kind filter applied the balance column is hidden, because the entries left out are needed to work it out.

The same data is available from the API; see the credits reference.

On this page