Home /API

Budgets API

Manage credits across orders and jobs using the API.

Overview

A budget lets you allocate and track credits across orders and processing jobs in your UP42 account.

Retrieve budgets

You can retrieve budgets in one of the following ways:

  • To fetch all or a subset of budgets for your account, call the Get budgets endpoint.
  • To fetch a specific budget, call the Get a budget endpoint with the budget ID as the path parameter.

Budget statuses

API statusDescriptionConsole status
ACTIVEThe budget can be assigned to orders and processing jobs to track credit usage.Active
INACTIVEThe budget can’t be assigned to orders or processing jobs.Inactive