---
title: "Get Balances"
method: GET
path: "/api/v1/balance"
tags: ["balance"]
---

# Get Balances

`GET /api/v1/balance`

## Request

- Base URL: `https://api.scade.pro` (the document declares no server; this is the origin it was published from)
- URL: `https://api.scade.pro/api/v1/balance`
- Auth: HTTP basic

## Headers

- `x-company-id` string
- `x-auth-as-staff` boolean
- `x-owner-payment-flag` boolean
- `x-auth-token` string
- `x-company-username` string
- `accept-language` string

## Cookies

- `ory_kratos_session` string

## Response `200`

Successful Response

- BalanceSchema
  - `current_offer` OfferSchema
    - `id` integer, required
    - `amount` integer
    - `price` number
    - `price_eur` number
    - `prices` object
    - `title` string
    - `execution_number` integer
    - `execution_period` integer
    - `image_url` string
    - `payment_mode_type` 'PAYMENT' | 'SUBSCRIPTION', required: An enumeration.
    - `payment_period` string
    - `payment_period_json` object
    - `payment_period_desc` string
    - `payment_period_timedelta` object
    - `order_value` integer, required
    - `offer_system_type` 1 | 2 | 3: An enumeration.
    - `description_config` object
    - `description_locale` object
    - `functionality_config` object
  - `order` BalanceOrderSchema
    - `id` integer
    - `offer` OfferSchema
      - `id` integer, required
      - `amount` integer
      - `price` number
      - `price_eur` number
      - `prices` object
      - `title` string
      - `execution_number` integer
      - `execution_period` integer
      - `image_url` string
      - `payment_mode_type` 'PAYMENT' | 'SUBSCRIPTION', required: An enumeration.
      - `payment_period` string
      - `payment_period_json` object
      - `payment_period_desc` string
      - `payment_period_timedelta` object
      - `order_value` integer, required
      - `offer_system_type` 1 | 2 | 3: An enumeration.
      - `description_config` object
      - `description_locale` object
      - `functionality_config` object
    - `status` 1 | 2 | 3 | 4 | 5, required: An enumeration.
    - `amount` number
    - `amount_eur` number
    - `currency` string
    - `payment_mode_type` 'PAYMENT' | 'SUBSCRIPTION', required: An enumeration.
    - `is_can_return_billing_url` boolean
    - `is_show_subscription_info_and_pages` boolean
    - `created` string, date-time
    - `order_next_sub_check` string, date-time
    - `last_send_date` string, date-time
    - `last_check_date` string, date-time
    - `cancel_date` string, date-time
    - `custom_user_start_date` string, date-time
    - `payment_owner_type` 1 | 2: An enumeration.
  - `available_tasks` AvailableTasksSchema
    - `paid_actions` number, required
    - `total_free` integer, required
    - `expired_at` string, date-time
    - `default_actions` number, required
    - `premium_actions` number, required
  - `payment_owner_type` 1 | 2: An enumeration.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/scade/apis/scade-prod.md) - [All operations](https://skmtc.dev/scade/apis/scade-prod/llms.txt) - [OpenAPI document](https://skmtc.dev/scade/apis/scade-prod/revisions/f3d7ba71abbc?raw)