Retrieve subscription payment information
Last updated: 25-Apr-2023
Rate this article:
Overview
Use the getSubscriptionPaymentInformation method to retrieve information related to the payment made for a subscription.
Parameters
| Parameters | Type/Description |
|---|---|
| sessionID | Required (String) |
| Session identifier, the output of the Login method. Include sessionID into all your requests. Avangate throws an exception if the values are incorrect. The sessionID expires in 10 minutes. | |
| subscriptionReference | Required (String) |
| The reference of the subscription you want to retrieve payment information for. |
Response
| Parameters | Type/Description | |
|---|---|---|
|
Type |
String |
|
|
|
Payment method type. |
|
|
Currency |
String |
|
|
|
ISO code of the order currency. |
|
|
PaymentMethod |
Object |
|
|
|
FirstDigits |
String |
|
|
|
First 4 digits of the card used on the order. |
|
|
LastDigits |
String |
|
|
|
Last 4 digits of the card used on the order. |
|
|
CardType |
String |
|
|
|
Type of card used on the order. |
| ExpirationMonth | String | |
| Card expiration month. | ||
| ExpirationYear | String | |
| Card expiration year. | ||
| CardUpdated | Boolean | |
| The card updated by our internal account updater. | ||
| Authorize3DSUrl | String | |
| URL address to which customers are redirected after the 3DS details get validated by the bank and the order is successfully authorized. | ||
Response sample
{
"Type": "CC",
"Currency": "USD",
"PaymentMethod": {
"FirstDigits": "4111",
"LastDigits": "1111",
"ExpirationMonth": null,
"ExpirationYear": null,
"CardUpdated": false,
"Authorize3DSUrl": null,
"CardType": "Visa"
}
}
Request
<?php
require ('PATH_TO_AUTH');
$subscriptionReference = "Subscription_Code";
$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'getSubscriptionPaymentInformation';
$jsonRpcRequest->params = array($sessionID, $subscriptionReference);
$jsonRpcRequest->id = $i++;
$paymentInformation = callRPC($jsonRpcRequest, $host);
var_dump($paymentInformation);
Rate this article:
