Получить счет | ToAPIs Documentation

GET

/api/v1/account/billing/invoices/%7Binvoice_id%7D

Для пользователей из материкового Китая: используйте https://toapis.cn в качестве эндпоинта (Base URL). Замените https://toapis.com на https://toapis.cn во всех примерах этого документа.

Аутентификация, пагинация и ошибки описаны в разделе Начало работы.

Поведение

Только основной аккаунт может читать собственные платежные данные. Для субаккаунта возвращается HTTP 403. Данные участников недоступны через этот метод.

По умолчанию 31 день, максимум 366 дней. Охватывается только текущий проверенный Customer: meta.coverage=current_customer_only. Изменение связи Customer аннулирует старые курсоры. Суммы являются десятичными строками по правилам Stripe: 2 знака для USD/CNY, 0 для JPY, 3 для KWD, совместимые 2 для ISK/UGX. subtotal/total: промежуточная/общая сумма; amount_due/amount_paid/amount_remaining: к оплате/оплачено/остаток. Без надежной связи с локальным заказом platform_trade_no=null; number и paid_at также могут быть null. ID Customer, email, адрес и URL счета не возвращаются. Нет связи: 409/15045, ошибка чтения: 503/15046, конфликт: 503/15047, а не выдуманный пустой список. Счет не равен локальному зачислению credits.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.

Параметры

invoice_idstringпутьобязательно

ID счета Stripe с префиксом in_.

Ограничения: maxLength=255; pattern=^in_[A-Za-z0-9_]+$.

Пример запроса

curl --request GET \
  --url 'https://toapis.com/api/v1/account/billing/invoices/in_example_01' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://toapis.com/api/v1/account/billing/invoices/in_example_01",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const url = new URL("https://toapis.com/api/v1/account/billing/invoices/in_example_01");

const response = await fetch(url, {
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Данные примеров вымышлены и предполагают credits_per_usd="100". Используйте коэффициент из ответа API.

codeinteger

Числовой код результата; 0 означает успех.

messagestring

Сообщение ответа; пустое при успехе. Сообщения об ошибках локализуются.

dataobject

Объект результата текущего запроса.

data.idstring

ID счета Stripe для получения деталей.

data.providerstring

Провайдер платежных услуг. Фиксированное значение: "stripe".

data.numberstring | null

Номер счета Stripe, отличный от ID счета. null, если значение неизвестно или неприменимо.

data.statusstring

Статус счета, возвращенный Stripe.

data.created_atstring | null

Время создания. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.currencystring

Исходная валюта сумм.

data.subtotalstring

Промежуточная сумма счета в исходной валюте currency. Десятичная строка для сохранения точности.

data.totalstring

Итоговая сумма счета в исходной валюте currency. Десятичная строка для сохранения точности.

data.amount_duestring

Сумма к оплате в исходной валюте currency. Десятичная строка для сохранения точности.

data.amount_paidstring

Оплаченная сумма в исходной валюте currency. Десятичная строка для сохранения точности.

data.amount_remainingstring

Оставшаяся сумма к оплате в исходной валюте currency. Десятичная строка для сохранения точности.

data.paid_atstring | null

Время оплаты счета по данным Stripe. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.platform_trade_nonull

Надежно связанный локальный номер пополнения; null, если связь не подтверждена.

data.metaobject

Метаданные об источнике, диапазоне и принципах учета.

data.meta.sourcestring

Источник данных. Локальная конфигурация или реестр не означают актуальное состояние Stripe. Фиксированное значение: "stripe".

data.meta.coveragestring

Охват счетов: только текущий проверенный Stripe Customer, не вся история. Фиксированное значение: "current_customer_only".

data.meta.scopestring

Область владельца данных: сам аутентифицированный аккаунт. Фиксированное значение: "self".

data.meta.fetched_atstring

Время получения данных из Stripe в этом запросе, не время создания счета. Время в RFC 3339 с часовым поясом.

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "id": "in_example_01",
    "provider": "stripe",
    "number": "EXAMPLE-0001",
    "status": "paid",
    "created_at": "2026-11-01T08:00:00Z",
    "currency": "USD",
    "subtotal": "10",
    "total": "10",
    "amount_due": "10",
    "amount_paid": "10",
    "amount_remaining": "0",
    "paid_at": "2026-11-01T08:01:00Z",
    "platform_trade_no": null,
    "meta": {
      "source": "stripe",
      "coverage": "current_customer_only",
      "scope": "self",
      "fetched_at": "2026-11-02T01:00:00Z"
    }
  }
}