ToAPIsToAPIs
Запросы аккаунтаПлатежи

Получить способ оплаты

Чтение данных своего аккаунта с системным токеном доступа

GET
/api/v1/account/billing/payment-method

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

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

Поведение

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

source=local_configuration означает локальную сводку карты по умолчанию, а не живой запрос Stripe или список всех карт. Без настройки configured=false, остальные поля карты равны null; отсутствующие поля могут оставаться null и после настройки. Полный номер карты и ID способа оплаты не возвращаются. GET не привязывает карты и не создает Customer.

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

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

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

Параметры

Параметры пути, параметры запроса и тело запроса не используются.

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

curl --request GET \
  --url 'https://toapis.com/api/v1/account/billing/payment-method' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'
import requests

response = requests.get(
    "https://toapis.com/api/v1/account/billing/payment-method",
    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/payment-method");

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.configuredboolean

Настроена ли карта по умолчанию. При false поля сводки карты равны null.

data.providerstring | null

Провайдер платежных услуг. null, если значение неизвестно или неприменимо.

data.typestring | null

Тип способа оплаты по умолчанию, например card. null, если значение неизвестно или неприменимо.

data.brandstring | null

Бренд карты по умолчанию, например visa. null, если значение неизвестно или неприменимо.

data.last4string | null

Последние 4 цифры карты; полный номер не возвращается. null, если значение неизвестно или неприменимо.

data.exp_monthinteger | null

Месяц истечения срока карты. null, если значение неизвестно или неприменимо.

data.exp_yearinteger | null

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

data.sourcestring

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

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

{
  "code": 0,
  "message": "",
  "data": {
    "configured": true,
    "provider": "stripe",
    "type": "card",
    "brand": "visa",
    "last4": "4242",
    "exp_month": 12,
    "exp_year": 2028,
    "source": "local_configuration"
  }
}