Cloud Billing#

Cloud committed-capacity billing and credits

List cloud billing commitments#

GET/organizations/{org_id}/cloud/commitments

List committed-capacity charges and refunds for cloud instances.

Parameters#

Name	Type	Location	Required	Description
`org_id`	string	path	Yes	Organization ID
`instance_id`	string	query	No	Optional cloud instance filter
`offset`	integer	query	No	Number of items to skip
`limit`	integer	query	No	Maximum number of items to return

Code Examples#

curl -X GET "https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/commitments?instance_id=550e8400-e29b-41d4-a716-446655440000&offset=0&limit=20" \
-H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://platform.antfly.io/api/v1/organizations/550e8400-e29b-41d4-a716-446655440000/cloud/commitments?instance_id=550e8400-e29b-41d4-a716-446655440000&offset=0&limit=20", {
method: "GET",
headers: {
  Authorization: "Bearer YOUR_TOKEN"
}
});

const data = await response.json();

Responses#

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "550e8400-e29b-41d4-a716-446655440000",
      "cloud_instance_id": "550e8400-e29b-41d4-a716-446655440000",
      "reason": "cloud_cycle_commitment",
      "billing_cycle_start": "2025-10-02T15:30:00Z",
      "billing_cycle_end": "2025-10-02T15:30:00Z",
      "window_start": "2025-10-02T15:30:00Z",
      "window_end": "2025-10-02T15:30:00Z",
      "credit_units": 0,
      "credit_units_delta": 0,
      "credits_consumed": 0,
      "credits_refunded": 0,
      "overage_credit_units": 0,
      "created_at": "2025-10-02T15:30:00Z",
      "instance_name": "string",
      "instance_slug": "string"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 1,
    "total": 0
  }
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

{
  "type": "https://platform.antfly.io/errors/validation-error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Email address is required",
  "instance": "https://platform.antfly.io/api/v1/users/550e8400-e29b-41d4-a716-446655440000",
  "errors": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}