Перейти к содержимому

Подписки

Общее

Swagger: https://api.radist.online/v2/docs#/Subscriptions

Необходимые права доступа (scopes) для работы с API: subscriptions

Подписка — сущность, к которой прикреплены подключения. Подключение, которое не в подписке, или в неоплаченной подписке, не работает.

Реквизиты — реквизиты ИП или ООО. Используются для выставления счетов на оплату.

Срок подписки

Пример подписки

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": 1926,
  "connections": [
    29228,
    30111
  ],
  "subscription_type": "CONNECTION_TELEGRAM_BOT",
  "current_size": 2,
  "max_size": 4,
  "test_until": "2022-11-27T07:17:28.784647Z",
  "paid_until": "2220-05-25T13:38:57.518834Z",
  "paused_at": null
}

Оставшийся срок подписки = paid_until - {текущие дата и время}

Примеры

Изменить список подключений в подписке
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
// После этой операции в подписке будет 2 подключения: 29228, 30111.

// В подписке может быть от 0 до `max_size` подключений.

POST /companies/{company_id}/subscriptions/{subscription_id}
{"connections":[29228, 30111]}


Response
{
  "id": 1926,
  "connections": [
    29228,
    30111
  ],
  "subscription_type": "CONNECTION_TELEGRAM_BOT",
  "current_size": 2,
  "max_size": 4,
  "test_until": "2022-11-27T07:17:28.784647Z",
  "paid_until": "2220-05-25T13:38:57.518834Z",
  "paused_at": null
}
Добавить реквизиты
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
POST /companies/{company_id}/subscriptions/requisites/
{
  "tin": "1699982918",
  "name": "ООО \"Маша и Миша\""
}


Response
{
  "id": 2004,
  "tin": "1699982918",
  "name": "ООО \"Маша и Миша\"",
  "approval_status": "APPROVED"
}
Выставить счёт на оплату подписок и WABA-диалогов
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
// 3 месяца, 3 подписки, 100 диалогов

// Получим предпросмотр (preview=true).
// Это не создаст счёт, но даст итоговую стоимость и состав счёта.
// Чтобы сформировать настоящий счёт, передайте preview=false.

// payment_method - CARD_RU (карта РФ), CARD_OTHER (карта не РФ),
// BANK_TRANSFER (банковский перевод, обязательно передать company_requisite_id)

POST /companies/{company_id}/subscriptions/invoices/
{
  "preview": true,
  "items": [
    {
      "type": "SUBSCRIPTION",
      "id": 11
    },
    {
      "type": "SUBSCRIPTION",
      "id": 1926
    },
    {
      "type": "SUBSCRIPTION",
      "id": 6752
    },
    {
      "type": "WABA_DIALOGS",
      "count": 100
    }
  ],
  "payment_method": "CARD_RU",
  "period_months": 3,
  "promo_code": null // Указать, если есть
}


Response // Это предпросмотр (id=0, preview=true)
{
  "id": 0,
  "preview": true,
  "status": "new",
  "lifetime": "2024-12-09T10:34:03.947066Z",
  "summary": {
    "payment_method": "CARD_RU",
    "period_months": 3,
    "items": [
      {
        "type": "SUBSCRIPTION",
        "subscription_id": 6752,
        "old_size": 2,
        "products": [
          {
            "connection_id": 45406,
            "amount": 3000,
            "discount": 300,
            "discounts": {
              "period_discount_percent": 10,
              "quantity_discount_percent": 0,
              "promo_discount_percent": 0,
              "partner_discount_percent": 0,
              "test_period_discount_percent": 0
            }
          },
          {
            "connection_id": 53991,
            "amount": 2400,
            "discount": 240,
            "discounts": {
              "period_discount_percent": 10,
              "quantity_discount_percent": 0,
              "promo_discount_percent": 0,
              "partner_discount_percent": 0,
              "test_period_discount_percent": 0
            }
          }
        ]
      },
      {
        "type": "SUBSCRIPTION",
        "subscription_id": 1926,
        "old_size": 1,
        "products": [
          {
            "connection_id": 29228,
            "amount": 4500,
            "discount": 450,
            "discounts": {
              "period_discount_percent": 10,
              "quantity_discount_percent": 0,
              "promo_discount_percent": 0,
              "partner_discount_percent": 0,
              "test_period_discount_percent": 0
            }
          }
        ]
      },
      {
        "type": "SUBSCRIPTION",
        "subscription_id": 11,
        "old_size": 2,
        "products": [
          {
            "connection_id": 31147,
            "amount": 15000,
            "discount": 1500,
            "discounts": {
              "period_discount_percent": 10,
              "quantity_discount_percent": 0,
              "promo_discount_percent": 0,
              "partner_discount_percent": 0,
              "test_period_discount_percent": 0
            }
          },
          {
            "connection_id": 55868,
            "amount": 10500,
            "discount": 1050,
            "discounts": {
              "period_discount_percent": 10,
              "quantity_discount_percent": 0,
              "promo_discount_percent": 0,
              "partner_discount_percent": 0,
              "test_period_discount_percent": 0
            }
          }
        ]
      },
      {
        "type": "WABA_DIALOGS",
        "count": 100,
        "price": 10.6915
      }
    ],
    "promo_code": null,
    "total_discount": 3540,
    "partner_discount_percent": 0,
    "company_requisite": null
  },
  "amount": 32929.15,
  "currency": "RUB",
  "payment_url": null,
  "preview_url": "https://invoices.radist.online/private/invoices/06019947-8962-4129-8276-cd9c388e4ba1",
  "act_url": null,
  "receipt": {
    "items": [
      {
        "name": "Лицензия на ПО для ЭВМ \"ЮKassa Radist.Online\"",
        "quantity": 1,
        "price": 4860
      },
      {
        "name": "Лицензия на ПО для ЭВМ \"Telegram Bot Radist.Online\"",
        "quantity": 1,
        "price": 4050
      },
      {
        "name": "Лицензия на ПО для ЭВМ \"WhatsApp Business API Radist.Online\"",
        "quantity": 1,
        "price": 22950
      },
      {
        "name": "Диалоги WhatsApp Business API",
        "quantity": 1,
        "price": 1069.15
      }
    ]
  },
  "created_at": "2024-12-02T10:34:03.945486Z"
}
Последнее обновление