Retrieve Subscription Request By Id
GET {{base_url}}/banking/v2/pay/subscription/subscription-requests/:subscriptionRequestId
This endpoint can be used to retrieve a particular subscription request .
Path variables
| Field | Type | Description |
|---|
| subscriptionRequestId | string | Unique identifier for the subscription request. |
Attributes
| Field | Type | Description |
|---|
| subscriptionRequestId | string | Unique identifier for subscription request |
| products | string | Comma-separated list of products that can be subscribed |
| frequency | string | Payment Frequency MONTHLY/QUARTERLY/SEMIANNUAL/ANNUAL/DAILY |
| amount | integer | Subscription amount |
| numberOfPayments | integer | the total number of payments to be made. |
| trialDuration | integer | trail duration in days |
| currency | string | currency |
| requestorBankAccount | string | Payee Bank Account details |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid subscriptionRequestId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |