> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Get Usage

- Component: `appmixer.autom.core.GetUsage`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.autom 1.0.0](https://connectors.appmixer.com/connector/appmixer.autom/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.autom/1.0.0/component/appmixer.autom.core.GetUsage>

Get the credit usage of the connected Autom account: credits used and remaining, and the renewal date.

## Input ports

### Port `in`

_No fields defined for this port._

## Output ports

### Port `out`

| Field | Type | Description |
| --- | --- | --- |
| Remaining Credits (`remaining`) | number | - |
| Credits Used (`total_used`) | number | - |
| Renewal Date (`renewal_date`) | string | - |
| Credits (`credits`) | object | - |
| Subscription (`subscription`) | object | - |
| Billing Period (`period`) | object | - |

## Full metadata (component.json)

```json
{
  "name": "appmixer.autom.core.GetUsage",
  "label": "Get Usage",
  "description": "Get the credit usage of the connected Autom account: credits used and remaining, and the renewal date.",
  "author": "Autom <josselin@autom.dev>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:autom"
  },
  "quota": {
    "manager": "appmixer:autom",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {}
      },
      "inspector": {
        "inputs": {}
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "schema": {
        "type": "object",
        "properties": {
          "remaining": {
            "type": "number",
            "title": "Remaining Credits",
            "example": 48500
          },
          "total_used": {
            "type": "number",
            "title": "Credits Used",
            "example": 1500
          },
          "renewal_date": {
            "type": "string",
            "title": "Renewal Date",
            "example": "2026-12-01"
          },
          "credits": {
            "type": "object",
            "title": "Credits",
            "properties": {
              "given": {
                "type": "integer",
                "title": "Credits.Given",
                "example": 50000
              },
              "consumed": {
                "type": "integer",
                "title": "Credits.Consumed",
                "example": 1500
              },
              "remaining": {
                "type": "integer",
                "title": "Credits.Remaining",
                "example": 48500
              },
              "percent_used": {
                "type": "integer",
                "title": "Credits.Percent Used",
                "example": 3
              }
            }
          },
          "subscription": {
            "type": "object",
            "title": "Subscription",
            "properties": {
              "used": {
                "type": "integer",
                "title": "Subscription.Used",
                "example": 1500
              },
              "total": {
                "type": "integer",
                "title": "Subscription.Total",
                "example": 50000
              },
              "remaining": {
                "type": "integer",
                "title": "Subscription.Remaining",
                "example": 48500
              },
              "percent_used": {
                "type": "integer",
                "title": "Subscription.Percent Used",
                "example": 3
              }
            }
          },
          "period": {
            "type": "object",
            "title": "Billing Period",
            "properties": {
              "start": {
                "type": "string",
                "title": "Billing Period.Start",
                "example": "2026-11-01"
              },
              "end": {
                "type": "string",
                "title": "Billing Period.End",
                "example": "2026-12-01"
              }
            }
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
