/v1/subscriptions/
Запрос на получение информации по подписке.
Возвращает идентификатор подписки, состояние подписки и привязанного способа оплаты.
Request
GET
https://pay.yandex.ru/api/merchant/v1/subscriptions/{customer_subscription_id}
Production
GET
https://sandbox.pay.yandex.ru/api/merchant/v1/subscriptions/{customer_subscription_id}
Sandbox
Path parameters
|
Name |
Description |
|
customer_subscription_id* |
Type: string ID подписки Max length: |
Body
application/json
{
"check_card_active": false
}
|
Name |
Description |
|
check_card_active |
Type: boolean Позволяет проверить привязку карты |
Responses
200 OK
Body
application/json
{
"code": 200,
"data": {
"cancelledAt": "2022-12-29T18:02:01Z",
"customerSubscriptionId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
"isCardActive": false,
"nextWriteOff": "2022-12-29T18:02:01Z",
"status": "NEW",
"subscriptionPlanId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b"
},
"status": "success"
}
|
Name |
Description |
|
code |
Type: number Default: |
|
data |
|
|
status |
Type: string Default: Enum: |
CustomerSubscriptionResponseData
|
Name |
Description |
|
status* |
Type: string Статус подписки Enum: |
|
subscriptionPlanId* |
Type: string<uuid> ID плана подписки Max length: |
|
cancelledAt |
Type: string<date-time> Время отмены подписки |
|
customerSubscriptionId |
Type: string<uuid> ID подписки Max length: |
|
isCardActive |
Type: boolean Статус привязанной карты |
|
nextWriteOff |
Type: string<date-time> Дата следующего списания |