Retrieve Subscription Requests
GET {{base_url}}/banking/v2/pay/subscription/subscription-requests?pageId=&products=
This endpoint can be used to retrieve subscription requests for a company.
Query Parameters
| Field | Type | Description |
|---|
| products | string | comma separated product list |
| pageId | string | Page offset of results |
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 partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | { error : "Missing/Invalid pageId” } |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | |
products | null | | |
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
Content-Type | string | | |
X-Api-Key | string | | |
X-Partner-Id | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"subscriptionRequestId":"65e3c92c-4d99-58e8-9d1b-0e4da9843021","requestorCompanyId":"01dfc92c-01cc-4442-93fd-878f516f46c7","products":"SMART_INVOICE","frequency":"MONTHLY","numberOfPayments":50,"trialDuration":45,"requestorBankAccount":{"accountId":"accountId1234","bankId":7,"name":"Debit Account","schemeName":"UK.OBIE.SortCodeAccountNumber","identification":"5000004001234","accountType":"BUSINESS"},"amount":"9.99","currency":"GBP","status":"","creationDate":"2022-01-20T20:29:03.199Z","updatedDate":"","resourceBaseurl":""}],"links":{}}