Plateshka
APIПодписки

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

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

POST/v1/subscriptions

providerMethodRef — токен сохранённого способа у провайдера, который вернула первая оплата. Номера карты в этом поле не будет никогда: PAN живёт ровно один вызов от формы оплаты до провайдера.

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

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

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

In: header

Заголовки

Idempotency-Key*string

Ключ повтора. Тот же ключ с тем же телом не выполняет операцию заново: возвращается сохранённый ответ и код 200 вместо 201. Живёт 24 часа.

Length1 <= length <= 255

Тело запроса

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Тело создания подписки.

Тело ответа

application/json

application/json

curl -X POST "https://example.com/v1/subscriptions" \  -H "Idempotency-Key: order-4815162342" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "amount": "49900",      "currency": "RUB"    },    "period": {      "unit": "month",      "count": 1    },    "method": "card",    "providerMethodRef": "pm_ExampleStoredMethodDoNotUse"  }'
{  "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"}