Stripe
Платежи, клиенты, подписки и счета Stripe
Stripe — приём платежей: Payment Intent, клиенты, подписки, счета, списания, товары и цены.
С Stripe в Pailot вы можете:
- Создавать, подтверждать, списывать и отменять Payment Intent
- Вести клиентов, подписки, счета и товары с ценами
- Смотреть события Stripe и запускать процесс как триггер (вебхук — входящий HTTP-запрос)
Нужен секретный ключ API (Application Programming Interface — программный интерфейс) Stripe. Суммы — в минимальных единицах валюты (центы). URL вебхука не публикуйте. Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Ключ — в переменных окружения рабочего пространства.
Создать Payment Intent — намерение платежа.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
amount | number | Да | Сумма в центах (например 2000 для 20,00 USD) |
currency | string | Да | Трёхбуквенный код валюты ISO (например usd, eur) |
customer | string | Нет | ID клиента для этого платежа |
payment_method | string | Нет | ID способа оплаты |
description | string | Нет | Описание платежа |
receipt_email | string | Нет | Email для чека |
metadata | json | Нет | Пары ключ–значение для доп. сведений |
automatic_payment_methods | json | Нет | Автоматические способы оплаты (например {"enabled": true}) |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Созданный объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Получить Payment Intent по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID Payment Intent (например pi_1234567890) |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Полученный объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Обновить Payment Intent.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID Payment Intent (например pi_1234567890) |
amount | number | Нет | Новая сумма в центах |
currency | string | Нет | Трёхбуквенный код валюты ISO |
customer | string | Нет | ID клиента |
description | string | Нет | Новое описание |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Обновлённый объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Подтвердить Payment Intent и завершить оплату.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID Payment Intent (например pi_1234567890) |
payment_method | string | Нет | ID способа оплаты для подтверждения |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Подтверждённый объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Списать авторизованный Payment Intent.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID Payment Intent (например pi_1234567890) |
amount_to_capture | number | Нет | Сумма списания в центах (по умолчанию вся) |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Списанный объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Отменить Payment Intent.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID Payment Intent (например pi_1234567890) |
cancellation_reason | string | Нет | Причина отмены: duplicate, fraudulent, requested_by_customer, abandoned |
| Параметр | Тип | Описание |
|---|
payment_intent | json | Отменённый объект Payment Intent |
metadata | json | Метаданные Payment Intent: ID, статус, сумма, валюта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Список Payment Intent.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
customer | string | Нет | Фильтр по ID клиента |
created | json | Нет | Фильтр по дате создания (например {"gt": 1633024800}) |
| Параметр | Тип | Описание |
|---|
payment_intents | json | Массив объектов Payment Intent |
metadata | json | Метаданные списка: count и has_more |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск Payment Intent по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "status:'succeeded' AND currency:'usd'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
payment_intents | json | Найденные объекты Payment Intent |
metadata | json | Метаданные поиска: count и has_more |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать клиента.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
email | string | Нет | Email клиента |
name | string | Нет | Полное имя клиента |
phone | string | Нет | Телефон клиента |
description | string | Нет | Описание клиента |
address | json | Нет | Адрес клиента |
metadata | json | Нет | Пары ключ–значение |
payment_method | string | Нет | ID способа оплаты to attach |
| Параметр | Тип | Описание |
|---|
customer | json | Созданный объект клиента |
metadata | json | Метаданные клиента |
↳ id | string | Уникальный идентификатор Stripe |
↳ email | string | Email клиента |
↳ name | string | Отображаемое имя |
Получить клиента по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID клиента (например cus_1234567890) |
| Параметр | Тип | Описание |
|---|
customer | json | Полученный объект клиента |
metadata | json | Метаданные клиента |
↳ id | string | Уникальный идентификатор Stripe |
↳ email | string | Email клиента |
↳ name | string | Отображаемое имя |
Обновить клиента.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID клиента (например cus_1234567890) |
email | string | Нет | Новый email |
name | string | Нет | Новое имя |
phone | string | Нет | Новый телефон |
description | string | Нет | Новое описание |
address | json | Нет | Новый адрес |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
customer | json | Обновлённый объект клиента |
metadata | json | Метаданные клиента |
↳ id | string | Уникальный идентификатор Stripe |
↳ email | string | Email клиента |
↳ name | string | Отображаемое имя |
Удалить клиента безвозвратно.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID клиента (например cus_1234567890) |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Клиент удалён |
id | string | ID удалённого клиента |
Список клиентов.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
email | string | Нет | Фильтр по email |
created | json | Нет | Фильтр по дате создания |
| Параметр | Тип | Описание |
|---|
customers | json | Массив клиентов |
metadata | json | Метаданные списка |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск клиентов по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "email:'customer@example.com'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
customers | json | Найденные клиенты |
metadata | json | Метаданные поиска |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать подписку клиента.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
customer | string | Да | ID клиента для подписки |
items | json | Да | Массив позиций с ID цен (например [{"price": "price_xxx", "quantity": 1}]) |
trial_period_days | number | Нет | Число дней пробного периода |
default_payment_method | string | Нет | ID способа оплаты |
cancel_at_period_end | boolean | Нет | Отменить подписку в конце периода |
metadata | json | Нет | Пары ключ–значение для доп. сведений |
| Параметр | Тип | Описание |
|---|
subscription | json | Созданный объект подписки |
metadata | json | Метаданные подписки: ID, статус, клиент |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ customer | string | ID связанного клиента |
Получить подписку по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID подписки (например sub_1234567890) |
| Параметр | Тип | Описание |
|---|
subscription | json | Полученный объект подписки |
metadata | json | Метаданные подписки: ID, статус, клиент |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ customer | string | ID связанного клиента |
Обновить подписку.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID подписки (например sub_1234567890) |
items | json | Нет | Новый массив позиций с ID цен |
cancel_at_period_end | boolean | Нет | Отменить подписку в конце периода |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
subscription | json | Обновлённый объект подписки |
metadata | json | Метаданные подписки: ID, статус, клиент |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ customer | string | ID связанного клиента |
Отменить подписку.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID подписки (например sub_1234567890) |
prorate | boolean | Нет | Пересчитать пропорционально при отмене |
invoice_now | boolean | Нет | Выставить счёт сразу |
| Параметр | Тип | Описание |
|---|
subscription | json | Отменённый объект подписки |
metadata | json | Метаданные подписки: ID, статус, клиент |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ customer | string | ID связанного клиента |
Возобновить подписку, которую собирались отменить.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID подписки (например sub_1234567890) |
| Параметр | Тип | Описание |
|---|
subscription | json | Возобновлённый объект подписки |
metadata | json | Метаданные подписки: ID, статус, клиент |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ customer | string | ID связанного клиента |
Список подписок.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
customer | string | Нет | Фильтр по ID клиента |
status | string | Нет | Фильтр по статусу: active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all |
price | string | Нет | Фильтр по ID цены |
| Параметр | Тип | Описание |
|---|
subscriptions | json | Массив подписок |
metadata | json | Метаданные списка |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск подписок по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "status:'active' AND customer:'cus_xxx'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
subscriptions | json | Найденные подписки |
metadata | json | Метаданные поиска |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать счёт.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
customer | string | Да | ID клиента (например cus_1234567890) |
description | string | Нет | Описание счёта |
metadata | json | Нет | Пары ключ–значение |
auto_advance | boolean | Нет | Автоматически финализировать счёт |
collection_method | string | Нет | Способ оплаты: charge_automatically или send_invoice |
| Параметр | Тип | Описание |
|---|
invoice | json | Созданный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Получить счёт по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
| Параметр | Тип | Описание |
|---|
invoice | json | Полученный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Обновить счёт.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
description | string | Нет | Описание счёта |
metadata | json | Нет | Пары ключ–значение |
auto_advance | boolean | Нет | Автоматически финализировать счёт |
| Параметр | Тип | Описание |
|---|
invoice | json | Обновлённый объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Удалить черновик счёта.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Счёт удалён |
id | string | ID удалённого счёта |
Финализировать черновик счёта.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
auto_advance | boolean | Нет | Автопродвижение счёта |
| Параметр | Тип | Описание |
|---|
invoice | json | Финализированный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Оплатить счёт.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
paid_out_of_band | boolean | Нет | Пометить счёт оплаченным вне Stripe |
| Параметр | Тип | Описание |
|---|
invoice | json | Оплаченный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Аннулировать счёт.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
| Параметр | Тип | Описание |
|---|
invoice | json | Аннулированный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Отправить счёт клиенту.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID счёта (например in_1234567890) |
| Параметр | Тип | Описание |
|---|
invoice | json | Отправленный объект счёта |
metadata | json | Метаданные счёта |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount_due | number | Остаток к оплате в минимальных единицах валюты |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Список счетов.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
customer | string | Нет | Фильтр по ID клиента |
status | string | Нет | Фильтр по статусу счёта |
| Параметр | Тип | Описание |
|---|
invoices | json | Массив счетов |
metadata | json | Метаданные списка |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск счетов по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "customer:'cus_1234567890'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
invoices | json | Найденные счета |
metadata | json | Метаданные поиска |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать списание (Charge).
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
amount | number | Да | Сумма в центах (например 2000 для 20,00 USD) |
currency | string | Да | Трёхбуквенный код валюты ISO (например usd, eur) |
customer | string | Нет | ID клиента для этого списания |
source | string | Нет | ID источника оплаты (токен карты или сохранённая карта) |
description | string | Нет | Описание списания |
metadata | json | Нет | Пары ключ–значение для доп. сведений |
capture | boolean | Нет | Списать сразу (по умолчанию true) |
| Параметр | Тип | Описание |
|---|
charge | json | Созданный объект Charge |
metadata | json | Метаданные списания: ID, статус, сумма, валюта, признак оплаты |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
↳ paid | boolean | Оплата получена |
Получить списание по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID списания (например ch_1234567890) |
| Параметр | Тип | Описание |
|---|
charge | json | Полученный объект Charge |
metadata | json | Метаданные списания: ID, статус, сумма, валюта, признак оплаты |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
↳ paid | boolean | Оплата получена |
Обновить списание.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID списания (например ch_1234567890) |
description | string | Нет | Новое описание |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
charge | json | Обновлённый объект Charge |
metadata | json | Метаданные списания: ID, статус, сумма, валюта, признак оплаты |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
↳ paid | boolean | Оплата получена |
Списать ещё не списанный Charge.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID списания (например ch_1234567890) |
amount | number | Нет | Сумма списания в центах (по умолчанию вся) |
| Параметр | Тип | Описание |
|---|
charge | json | Списанный объект Charge |
metadata | json | Метаданные списания: ID, статус, сумма, валюта, признак оплаты |
↳ id | string | Уникальный идентификатор Stripe |
↳ status | string | Текущее состояние ресурса |
↳ amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
↳ paid | boolean | Оплата получена |
Список списаний.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
customer | string | Нет | Фильтр по ID клиента |
created | json | Нет | Фильтр по дате создания (например {"gt": 1633024800}) |
| Параметр | Тип | Описание |
|---|
charges | json | Массив объектов Charge |
metadata | json | Метаданные списка: count и has_more |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск списаний по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "status:'succeeded' AND currency:'usd'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
charges | json | Найденные объекты Charge |
metadata | json | Метаданные поиска: count и has_more |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать товар.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
name | string | Да | Название товара |
description | string | Нет | Описание товара |
active | boolean | Нет | Товар активен |
images | json | Нет | URL изображений товара |
metadata | json | Нет | Пары ключ–значение |
| Параметр | Тип | Описание |
|---|
product | json | Созданный объект товара |
metadata | json | Метаданные товара |
↳ id | string | Уникальный идентификатор Stripe |
↳ name | string | Отображаемое имя |
↳ active | boolean | Ресурс сейчас активен |
Получить товар по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID товара (например prod_1234567890) |
| Параметр | Тип | Описание |
|---|
product | json | Полученный объект товара |
metadata | json | Метаданные товара |
↳ id | string | Уникальный идентификатор Stripe |
↳ name | string | Отображаемое имя |
↳ active | boolean | Ресурс сейчас активен |
Обновить товар.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID товара (например prod_1234567890) |
name | string | Нет | Новое название товара |
description | string | Нет | Новое описание товара |
active | boolean | Нет | Новый статус активности |
images | json | Нет | Новые URL изображений |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
product | json | Обновлённый объект товара |
metadata | json | Метаданные товара |
↳ id | string | Уникальный идентификатор Stripe |
↳ name | string | Отображаемое имя |
↳ active | boolean | Ресурс сейчас активен |
Удалить товар безвозвратно.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID товара (например prod_1234567890) |
| Параметр | Тип | Описание |
|---|
deleted | boolean | Товар удалён |
id | string | ID удалённого товара |
Список товаров.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
active | boolean | Нет | Фильтр по активности |
| Параметр | Тип | Описание |
|---|
products | json | Массив товаров |
metadata | json | Метаданные списка |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск товаров по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "name:'shirt'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
products | json | Найденные товары |
metadata | json | Метаданные поиска |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Создать цену товара.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
product | string | Да | ID товара (например prod_1234567890) |
currency | string | Да | Трёхбуквенный код валюты ISO (например usd, eur) |
unit_amount | number | Нет | Сумма в центах (например 1000 для 10,00 USD) |
recurring | json | Нет | Периодическая оплата (interval: day/week/month/year) |
metadata | json | Нет | Пары ключ–значение |
billing_scheme | string | Нет | Схема тарифа: per_unit или tiered |
| Параметр | Тип | Описание |
|---|
price | json | Созданный объект цены |
metadata | json | Метаданные цены |
↳ id | string | Уникальный идентификатор Stripe |
↳ product | string | ID связанного товара |
↳ unit_amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Получить цену по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID цены (например price_1234567890) |
| Параметр | Тип | Описание |
|---|
price | json | Полученный объект цены |
metadata | json | Метаданные цены |
↳ id | string | Уникальный идентификатор Stripe |
↳ product | string | ID связанного товара |
↳ unit_amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Обновить цену.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID цены (например price_1234567890) |
active | boolean | Нет | Цена активна |
metadata | json | Нет | Новые метаданные |
| Параметр | Тип | Описание |
|---|
price | json | Обновлённый объект цены |
metadata | json | Метаданные цены |
↳ id | string | Уникальный идентификатор Stripe |
↳ product | string | ID связанного товара |
↳ unit_amount | number | Сумма в минимальных единицах валюты (например центы) |
↳ currency | string | Трёхбуквенный код валюты ISO (строчными) |
Список цен.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
product | string | Нет | Фильтр по ID товара |
active | boolean | Нет | Фильтр по активности |
| Параметр | Тип | Описание |
|---|
prices | json | Массив цен |
metadata | json | Метаданные списка |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Поиск цен по синтаксису запросов Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
query | string | Да | Поисковый запрос (например "active:'true' AND currency:'usd'") |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
| Параметр | Тип | Описание |
|---|
prices | json | Найденные цены |
metadata | json | Метаданные поиска |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
Получить событие Stripe по ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
id | string | Да | ID события (например evt_1234567890) |
| Параметр | Тип | Описание |
|---|
event | json | Полученный объект Event |
metadata | json | Метаданные события: ID, тип, время создания |
↳ id | string | Уникальный идентификатор Stripe |
↳ type | string | Идентификатор типа события |
↳ created | number | Unix-время создания |
Список событий Stripe.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Секретный ключ API Stripe |
limit | number | Нет | Сколько результатов вернуть (по умолчанию 10, максимум 100) |
type | string | Нет | Фильтр по типу события (например payment_intent.created) |
created | json | Нет | Фильтр по дате создания (например {"gt": 1633024800}) |
| Параметр | Тип | Описание |
|---|
events | json | Массив событий |
metadata | json | Метаданные списка: count и has_more |
↳ count | number | Число возвращённых элементов |
↳ has_more | boolean | Есть ещё элементы после этой страницы |
