Get monthly usage

GET 
/v2/users/me/usage/monthly

Returns a complete summary of your usage for the current usage cycle, an overall sum, as well as a daily breakdown of usage. It is the same information you will see on your account's Billing page. The information includes your use of storage, data transfer, and request queue usage.

Using the date parameter will show your usage in the usage cycle that includes that date.

Request

Query Parameters

date string
Date in the YYYY-MM-DD format.

Example: 2020-06-14

Status 200

Response Headers

{
  "data": {
    "usageCycle": {
      "startAt": "2022-10-02T00:00:00.000Z",
      "endAt": "2022-11-01T23:59:59.999Z"
    },
    "monthlyServiceUsage": {},
    "dailyServiceUsages": [
      {
        "date": "2022-10-02T00:00:00.000Z",
        "serviceUsage": {
          "ACTOR_COMPUTE_UNITS": {
            "quantity": 60,
            "baseAmountUsd": 0.00030000000000000003,
            "baseUnitPriceUsd": 0.000005,
            "amountAfterVolumeDiscountUsd": 0.00030000000000000003,
            "priceTiers": []
          }
        },
        "totalUsageCreditsUsd": 0.0474385791970591
      }
    ],
    "totalUsageCreditsUsdBeforeVolumeDiscount": 0.786143673840067,
    "totalUsageCreditsUsdAfterVolumeDiscount": 0.786143673840067
  }
}

Schema

• data object required

  • usageCycle object required

    • startAt string<date-time> required
      Example: 2022-10-02T00:00:00.000Z
    • endAt string<date-time> required
      Example: 2022-11-01T23:59:59.999Z
  • monthlyServiceUsage object required

    A map of usage item names (e.g., ACTOR_COMPUTE_UNITS) to their usage details.

    • property name* UsageItem

      • quantity number required
        Example: 2.784475
      • baseAmountUsd number required
        Example: 0.69611875
      • baseUnitPriceUsd number
        Example: 0.25
      • amountAfterVolumeDiscountUsd number
        Example: 0.69611875
      • priceTiers object[]

        • quantityAbove number required
          Example: 0
        • discountPercent number required
          Example: 100
        • tierQuantity number required
          Example: 0.39
        • unitPriceUsd number required
          Example: 0
        • priceUsd number required
          Example: 0
  • dailyServiceUsages object[] required

    • date string required
      Example: 2022-10-02T00:00:00.000Z
    • serviceUsage object required

      A map of service usage item names to their usage details.

      • property name* UsageItem

        • quantity number required
          Example: 2.784475
        • baseAmountUsd number required
          Example: 0.69611875
        • baseUnitPriceUsd number
          Example: 0.25
        • amountAfterVolumeDiscountUsd number
          Example: 0.69611875
        • priceTiers object[]

          • quantityAbove number required
            Example: 0
          • discountPercent number required
            Example: 100
          • tierQuantity number required
            Example: 0.39
          • unitPriceUsd number required
            Example: 0
          • priceUsd number required
            Example: 0
    • totalUsageCreditsUsd number required
      Example: 0.0474385791970591
  • totalUsageCreditsUsdBeforeVolumeDiscount number required
    Example: 0.786143673840067
  • totalUsageCreditsUsdAfterVolumeDiscount number required
    Example: 0.786143673840067

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 401

Unauthorized - authentication required or invalid token.

{
  "error": {
    "type": "token-not-valid",
    "message": "Authentication token is not valid."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 403

Forbidden - insufficient permissions to perform this action.

{
  "error": {
    "type": "permission-denied",
    "message": "You do not have permission to perform this action."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 405

Method not allowed.

{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 429

Too many requests - rate limit exceeded.

{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)