Get 2023 10 12farmsfarmidbudgetsbudgetid

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Get a budget.

get/2023-10-12/farms/{farmId}/budgets/{budgetId}

Path parameters

farmIdstring required

The farm ID of the farm connected to the budget.

budgetIdstring required

The budget ID.

Response

Success

budgetIdstring required

The budget ID.

status'ACTIVE' | 'INACTIVE' required

The status of the budget. <ul> <li> <code>ACTIVE</code>–Get a budget being evaluated. </li> <li> <code>INACTIVE</code>–Get an inactive budget. This can include expired, canceled, or deleted statuses. </li> </ul>

displayNamestring required

The display name of the budget. <important> This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. </important>

approximateDollarLimitnumber float required

The consumed usage limit for the budget.

createdBystring required

The user or system that created this resource.

createdAtstring date-time required

The date and time the resource was created.

updatedBystring

The user or system that updated this resource.

updatedAtstring date-time

The date and time the resource was updated.

descriptionstring password

The description of the budget. <important> This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field. </important>

queueStoppedAtstring date-time

The date and time the queue stopped.