SATIK API · V1 BETA

Read monthly usage

GET

https://api.satik.in/v1/usage

Use a server-side Bearer API key. Authentication guide →

Sample request (cURL)

Set the Postman variable SATIK_TEST_KEY to a test key from your workspace.

curl --request GET 'https://api.satik.in/v1/usage' \
  --header 'Authorization: Bearer {{SATIK_TEST_KEY}}'

Reads the current workspace’s monthly usage and plan information. A test key still returns actual workspace usage; this is not simulated data. No request body is needed.

In Postman, choose Import and paste this cURL command. These double-brace variables are resolved by Postman; for a terminal request, replace them with actual values. For local testing, replace https://api.satik.in/v1 with http://localhost:3001/api/v1, keeping the endpoint path.

Responses and errors

HTTP 200

{
  "description": "Success",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "period": {
            "type": "string"
          },
          "plan": {
            "type": "string"
          },
          "included": {
            "type": "number"
          },
          "used": {
            "type": "number"
          },
          "remaining": {
            "type": "number"
          },
          "overage_paise": {
            "type": "number"
          }
        }
      }
    }
  }
}

HTTP 400

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 401

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 403

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 409

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 422

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 429

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 500

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 502

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 503

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

HTTP 504

{
  "description": "Request failed. Inspect error.code and request_id.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

View shared schemas →