How to create invoices for credit grants

Last updated: September 20, 2024

How to create an invoice for a credit grant via the UI

  1. Navigate to the customer's page in Orb:

    • Click on “Adjust Credits”.

  2. Add Credits:

    • Enter the amount of credits to be added, for example, 250 credits.

    • • Set the cost per credit, e.g., $1 per credit.

  3. Select "Create an invoice for this purchase" :

  1. Collect payment from the customer

How to create an invoice for a credit grant via the API

  1. Use the create credit ledger API endpoint:

    • To create an invoice for the credit increment, you must specify a per_unit_cost_basis and invoice_settings in the request.

  2. Determine whether the credits should be granted before or after successful payment.

  3. Charge the customer:

    • The credit increment can be automatically charged to your customer or you can send them a link to the invoice. When the invoice is paid, the credits will be granted to the customer.