Subscription

Get Subscription

GET /residential/subscription

Example request:

curl -X GET https://resi-api.iproyal.com/v1/residential/subscription \
     -H "Authorization: Bearer <your_api_token>"

Example response:

{
  "quantity": 1000,
  "amount": 3150,
  "status": "paid",
  "next_payment_date": "2025-07-26",
  "payment_method": "balance",
  "card_id": null
}

Delete Subscription

DELETE /residential/subscription

Example request:

curl -X DELETE https://resi-api.iproyal.com/v1/residential/subscription \
     -H "Authorization: Bearer <your_api_token>"
     -H "Content-Type: application/json" 

Change payment method

POST /residential/subscription/change-payment-method

Query Parameters:

Name
Type
Description

payment_method

String

balance or card

card_id

Integer

Card that is attached to the user

Example request:

curl -X POST https://resi-api.iproyal.com/v1/residential/subscription/change-payment-method \
     -H "Content-Type: application/json" \
     -H "Authorization: Bearer <your_api_token>" \
     -d '{
           "payment_method": "card",
           "card_id": 1231
         }'

Last updated