Unitpay
en
en
  • Home
  • First steps
    • Registration
    • Adding a Project
      • Adding a VK Community Project
    • Project Moderation
    • Transfer of the Project
    • Video tutorials
  • Payments
    • Creating a payment (easy way)
    • Creating a Payment
    • Creating a payment (widget)
    • Parameters for receipts
    • Creating Payment Links in Your Personal Account
    • Payment Handler
    • Payment information
    • Payment Refund
    • Payments with Pre-authorization
    • Recurring payments
      • Creating a Subscription
      • Getting Information About Subscription
      • Getting a List of Active Subscriptions
      • Closing a Subscription
  • Mass payouts
    • Creating a payout
    • Information about Payout
    • Card information by BIN
    • Payments based on a CSV registry
  • Online cash desk
    • Parameters for generating a receipt
    • Unit.Reciepts
    • Adding online cash desk
    • Types of Online Cash Register Receipt Items
    • Advance credit reciepts
  • Modules
    • Payment handler
    • Unitpay SDK
    • CMS modules
      • Amiro
      • PHPShop
      • 1C Bitrix
      • CS-Cart
      • DIAFAN.CMS
      • Drupal 7 (commerce)
      • Drupal 7 (ubercart 3)
      • Drupal 8, 9 (commerce)
      • Ecwid by Lightspeed
      • HostCMS
      • InSales
      • Joomshopping 4 (joomla 3)
      • LogicBoxes
      • Magento
      • Magento 2
      • OpenCart
      • osCommerce
      • Prestashop
      • ReadyScript
      • ShopCMS
      • Simpla
      • Tilda
      • Netcat CMS
      • UMI.CMS
      • VamShop 2
      • VirtueMart 3 (joomla 3)
      • Webasyst Shop Script 7 (8)
      • Wix
      • Woocommerce Wordpress
      • Zen Cart
      • Amiro CMS
      • CMS NWICODE
      • MODX (miniShop2)
  • Manage Unitpay
    • Interface Instructions
    • SP documents
    • Legal entity documents
    • Current Balance
    • Commissions
    • Currency Conversion Rates
  • Book of reference
    • System IP addresses
    • Payment Form Appearance
    • Using the Test API
    • Operator Codes
    • Payment System Codes
    • Currency codes
    • Qiwi Country Codes
  • Referral program
    • Interface of Referrer's (Agent's) Account
  • Support
  • Other
    • Telegram bot
    • Using the Test API
  • Google Pay™
Powered by GitBook
On this page

Was this helpful?

  1. Payments
  2. Recurring payments

Getting Information About Subscription

PreviousCreating a SubscriptionNextGetting a List of Active Subscriptions

Last updated 4 years ago

Was this helpful?

Required parameters:

****

Value

Description

subscriptionId

number

Subscription ID in the UnitPay system

secretKey

line

Secret key, available in the project settings

Successful response

Value

Description

subscriptionId

number

Subscription ID in the UnitPay system

description

line

Text description of the subscription

status

line

Subscription status: new — subscription created, no attempts of debiting under the subscription have occurred yet active — subscription is active close — subscription is closed

startDate

line

Subscription creation date in the YYYY-mm-dd HH:ii:ss format (for example, 2012-10-01 12:32:00)

successPayments

number

Number of successful payments under the subscription

failPayments

number

Number of failed attempts of debiting under the subscription

lastPaymentId

number

ID of the last payment under the subscription

lastUpdateDate

line

Date of the last payment under the subscription in the YYYY-mm-dd HH:ii:ss format (for example, 2012-10-01 12:32:00)

parentPaymentId

number

ID of the parent payment that initiated the subscription

totalSum

number

The total amount debited from the payer under the subscription

closeType

line

Reason for closing the subscription (transmitted only if status=close): api — subscription was closed by the API partner error — subscription was closed due to reaching the limit on the number of errors when trying to debit the funds abuse — subscription was closed due to the subscriber's complaint

Error response

Value

Description

message

line

Information with a description of the error

You can run the query in test mode.

Learn more