Plateshka
APIПодписки

Лента подписок

Массив подписок проекта от новых к старым. Курсора нет: выдачу ограничивает `limit`, до сотни за раз.

GET/v1/subscriptions

Массив подписок проекта от новых к старым. Курсора нет: выдачу ограничивает limit, до сотни за раз.

Авторизация

apiKey
АвторизацияBearer <token>

Заголовок Authorization: Bearer <ключ>, например Authorization: Bearer plt_ExampleKeyDoNotUseExampleKeyDoNotUse01. Название схемы сравнивается без учёта регистра. Ключ начинается с plt_; храним мы только его SHA-256, поэтому потерянный ключ не восстанавливается — он перевыпускается.

In: header

Параметры запроса

status?string

Фильтр по статусу, ровно одному. Что означает каждый — в разделе «Статусы подписки».

Value in

  • "active"
  • "paused"
  • "past_due"
  • "cancelled"
limit?integer

Сколько подписок вернуть. Постраничной выдачи здесь нет: подписок у проекта на два порядка меньше, чем счетов.

Range1 <= value <= 100

Тело ответа

application/json

application/json

curl -X GET "https://example.com/v1/subscriptions?status=active&limit=50"
[  {    "id": "d4e5f607-8192-4a34-bb5c-6d7e8f901234",    "status": "active",    "amount": {      "amount": "49900",      "currency": "RUB"    },    "period": {      "unit": "month",      "count": 1    },    "description": "Подписка «Про», ежемесячно",    "method": "card",    "methodMask": "4488 22** **** 4213",    "metadata": {      "plan": "pro"    },    "startedAt": "2026-08-19T10:20:00Z",    "nextChargeAt": "2026-09-19T10:20:00Z",    "lastChargedAt": "2026-08-19T10:20:07Z",    "cyclesStarted": 1,    "createdAt": "2026-08-19T10:20:00Z"  }]

Получить возврат

Назад

Создать подписку

`providerMethodRef` — токен сохранённого способа у провайдера, который вернула первая оплата. Номера карты в этом поле не будет никогда: PAN живёт ровно один вызов от формы оплаты до провайдера. Списывать по сохранённому способу умеет не всякий провайдер. Мы спрашиваем об этом здесь, а не при первом списании: если способ, подключённый вашему проекту, так не умеет, `422 method_unavailable` приходит сразу — а не через месяц, отсутствием оплат.