> ## Documentation Index
> Fetch the complete documentation index at: https://developers.papelship.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Продаж підписок із картковими платежами PapelPay

> Створюйте замовлення Store API, які поновлюються щоперіоду через PapelPay: встановіть auto_renew, читайте об'єкт підписки та відстежуйте або зупиняйте поновлення після оплати.

Товар із увімкненими підписками та розрахунковим періодом можна купити за підпискою. Коли клієнт оплачує через PapelPay, кошти з картки списуються повторно щоперіоду, доки він не скасує підписку. З будь-яким іншим способом оплати клієнт отримує рахунок на поновлення електронною поштою перед завершенням кожного періоду. На цій сторінці показано, як керувати цим вибором через Store API.

## Оберіть підписку або одноразову покупку

Надішліть `auto_renew` під час створення замовлення:

| Значення | Результат |
| :- | :- |
| `true` | Замовлення купується як підписка. Клієнт не може вимкнути її під час оформлення. |
| `false` | Замовлення є одноразовою покупкою. Сторінка оформлення не показує варіанту підписки. |
| Не вказано | Клієнт обирає під час оформлення. Підписку вибрано за замовчуванням. |

```bash theme={"system"}
curl -X POST https://app.papelship.com/api/v1/invoices \
  -H "x-api-key: pk_live_your_key" \
  -H "x-store-hash: your_store_id" \
  -H "Idempotency-Key: WEB-2087" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_email": "buyer@example.com",
    "items": [{ "product_id": "Pr0Mnth1yX9a" }],
    "auto_renew": true,
    "payment_method": "PAPELPAY"
  }'
```

`auto_renew: true` потребує замовлення рівно з однією товарною позицією, і для цього товару мають бути увімкнені підписки з розрахунковим періодом. Інакше виклик завершується помилкою `SUBSCRIPTION_NOT_AVAILABLE` (`422`), і замовлення не створюється.

## Об'єкт підписки

Відповіді на створення та отримання деталей замовлення містять `subscription`. Він дорівнює `null`, якщо замовлення не може бути підпискою.

```json theme={"system"}
"subscription": {
  "enabled": true,
  "locked": true,
  "interval_days": 30,
  "interval": "month",
  "discount_percent": 20,
  "discount_applies_to": "automatic_payments",
  "discount_cents": 0,
  "subscription_id": null,
  "auto_renewal_id": null
}
```

| Поле | Значення |
| :- | :- |
| `enabled` | `true`: куплено як підписку. `false`: одноразова покупка. |
| `locked` | Встановлюється через `auto_renew` під час створення. Клієнт не може змінити це під час оформлення. |
| `interval_days`, `interval` | Розрахунковий період. `interval` має значення `day`, `week`, `month` або `year` для стандартних періодів, інакше `null`. |
| `discount_percent` | Знижка для підписників, задана в товарі. |
| `discount_applies_to` | `automatic_payments`: лише коли підписка автоматично поновлюється з картки. `all_payment_methods`: з будь-яким способом оплати. |
| `discount_cents` | Знижка, яка наразі врахована в `total_cents`. Залишається `0`, доки клієнт не обере спосіб оплати, до якого вона застосовується. |
| `subscription_id` | Після оплати: запис підписки. |
| `auto_renewal_id` | Після оплати карткою через PapelPay: автоматичне поновлення з картки. |

## Після оплати

Перший платіж завершує замовлення та запускає підписку. Кожне поновлення створює нове оплачене замовлення та подовжує підписку. Переглядайте та зупиняйте підписки через ці ендпоінти:

| Дія | Ендпоінт |
| :- | :- |
| Список підписок | `GET /subscriptions` |
| Одна підписка разом із її платежами | `GET /subscriptions/{subscriptionId}` |
| Скасувати | `POST /subscriptions/{subscriptionId}/cancel` |
| Список автоматичних поновлень з картки | `GET /subscriptions/auto-renewals` |
| Зупинити майбутні списання з картки | `POST /subscriptions/auto-renewals/{renewalId}/cancel` |

Зупинка автоматичного поновлення припиняє майбутні списання після завершення оплаченого періоду. Скасування ніколи не повертає кошти клієнту.

> [!NOTE]
>
> Карткові платежі за підписками списуються в USD.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.