Skip to main content

Get Subscription Details

Get the subscription details.

Post
https://store.payproglobal.com/api/Subscriptions/GetSubscriptionDetails
Request Parametersapplication/json
GetSubscriptionDetailsRequestModel
object
dateFormat
string
optional
The date format in which you want to receive the information. Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
subscriptionId
integer
required
The subscription ID that needs to be updated.
vendorAccountId
integer
required
The vendor account ID identifies your PayPro Global account.
It can be found in Account settings > Business info.
apiSecretKey
string
required
The vendor account API secret key is a unique key
that was generated specifically for authenticating API requests.
It can be found in Store settings > General settings > Integration tab.
Response Parametersapplication/json
GetSubscriptionDetailsResponseModel
object
response
object
status
string
The status of the subscription.
createdAt
string
The subscription creation date in the chosen format in dateFormat.
nextPayment
string
The date of the upcoming subscription payment.
lastPayment
string
The date of the last subscription payment.
currentChargeCounter
integer
The number of the subscription payments that took place.
subscriptionName
string
The name of the subscription.
productId
integer
The product ID associated with the subscription.
subscriptionPrice
number
The subscription recurring price.
subscriptionCurrency
string
The currency in which the subscription is paid.
subscriptionPeriod
string
The subscription billing period.
subscriptionPeriodValue
integer
The value of the subscription billing period.
quantity
integer
The chosen subscription quantity.
isTrial
boolean
Possible values are true or false.
If true, the subscription is on trial period.
If false, there is no trial period.
renewalType
string
The subscription renewal type.
discountToBeApplied
string
The discount amount applied to the subscription via API method Apply Discount.
affiliateAgreementId
integer
The affiliate agreement ID assigned to the subscription.
coupons
array[object]
name
string
A coupon code name.
isPercentage
boolean
Possible values are true or false. If true, the percentage discount was applied; false otherwise.
discount
number
The percentage or amount of the discount applied by the coupon.
cyclesLeft
number
The number of remaining cycles the coupon can be used before expiration.
orders
array[object]
The list of all orders of the current subscription.
id
integer
The order ID.
billingCurrencyCode
string
The billing currency code.
billingTotalPrice
number
The total price in a billing currency.
billingTotalTaxesAmount
number
The total tax amount in a billing currency.
billingTotalPriceWithTaxes
number
The total price with the tax amount in a billing currency.
orderStatusId
integer
The order status ID.
Possible values: 1 – Waiting,
2 – Canceled, 3 –Refunded,
4 – Chargeback, 5 – Processed.
paymentMethodId
integer
The payment method ID.
orderStatusName
string
The text representation of the order status.
paymentMethodName
string
The text representation of the payment method.
createdAt
string
The date when the order was created.
affiliateAgreementId
integer
The affiliate agreement ID assigned to the subscription.
request
object
dateFormat
string
Date format. Possible values:
a - "yyyy-MM-ddTHH:mm:ss.fff"
b - "M/d/yyyy"
c - "d-MMM-yyyy"
subscriptionId
integer
Subscription id.
vendorAccountId
integer
Vendor account id.
apiSecretKey
string
Vendor account API secret key.
errors
array[object]
propertyWithError
string
propertyErrorMessages
array[string]
isSuccess
boolean
Request Sample
{
  "dateFormat": "a",
  "subscriptionId": 1111111,
  "vendorAccountId": 123456,
  "apiSecretKey": "your_api_secret_key"
}
Response Sample
{
  "response": {
    "status": "Active",
    "createdAt": "2023-09-09T10:32:46.097",
    "nextPayment": "2024-03-29T11:29:59.837",
    "lastPayment": "2024-02-29T11:29:59.837",
    "currentChargeCounter": 1,
    "subscriptionName": "Premium Subscription (Includes: - basic features)",
    "productId": 37491,
    "subscriptionPrice": 58.83,
    "subscriptionCurrency": "EUR",
    "subscriptionPeriod": "Months",
    "subscriptionPeriodValue": 1,
    "quantity": 1,
    "isTrial": false,
    "renewalType": "Auto",
    "discountToBeApplied": 0.0,
    "affiliateAgreementId": null,
    "coupon": [
      {
        "name": "coupon_name",
        "isPercentage": true,
        "discount": 20.00,
        "cyclesLeft": null
      }
    ],
    "orders": [{
      "id": 12345678,
      "billingCurrencyCode": "EUR",
      "billingTotalPrice": 105.04,
      "billingTotalTaxesAmount": 19.96,
      "billingTotalPriceWithTaxes": 125.00,
      "orderStatusId": 5,
      "paymentMethodId": 2,
      "orderStatusName": "Processed",
      "paymentMethodName": "Visa",
      "createdAt": "2023-09-09T10:32:46.097",
      "affiliateAgreementId": null,
    }]
  },
  "request": {
    "dateFormat": "a",
    "subscriptionId": 1111111,
    "vendorAccountId": 123456,
    "apiSecretKey": "your_api_secret_key"
  },
  "errors": [],
  "isSuccess": true
}