API Reference
Account Groups
Retrieve All Subscriptions
1min
GET
This endpoint will enable you to retrieve all subscriptions that are against a specific account group.
Authentication
Authorization
Bearer
Path Parameters
accountGroupToken
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
OK
FictiveGlobal.Api.Rest.Dtos.v1.AccountSubscriptionResult
Description
Account Subscription result
subscriptions
FictiveGlobal.Api.Rest.Dtos.v1.AccountSubscription[]
204
No subscriptions found.
FictiveGlobal.Api.Rest.Dtos.v1.AccountSubscriptionResult
Description
Account Subscription result
subscriptions
FictiveGlobal.Api.Rest.Dtos.v1.AccountSubscription[]
400
Request is invalid.
403
Unable to authenticate using the provided session.
500
Internal Server Error.
Curl
JS
Ruby
Python
1curl --location --globoff 'https://api.fictive.com/REST/api/accounts/groups/{accountGroupToken}/subscriptions' \
2--header 'Accept: application/json' \
3--header 'Content-Type: application/json'
Responses
200
204
400
403
500
1{
2 "subscriptions": [
3 {
4 "accountSubscriptionInfo": {
5 "expiryDate": "2021-09-21T05:33:09.4477272",
6 "firstNonDiscountedBillingPointUtc": "2021-08-21T05:33:09.4477272",
7 "lastDiscountedBillingPointUtc": "2021-07-21T05:33:09.4477272",
8 "paymentMethod": "CreditDebitCard",
9 "recurringPaymentInfo": {
10 "subscriptionReference": 123455,
11 "resourceReference": "ResourceReference",
12 "configuredSubscriptionPrice": 10,
13 "subscribedPrice": 10.21,
14 "currency": "GBP",
15 "recurringPaymentEnable": false,
16 "subscriptionLockedIn": false,
17 "nextPaymentDate": "2021-10-21T05:33:09.4477272",
18 "previousBillingInfo": {
19 "subscriptionPriceId": 94852,
20 "totalAmount": 10,
21 "totalTaxAmount": 8.33,
22 "totalNetAmount": 1.667,
23 "billingDate": "2021-09-20T05:33:09.4477272",
24 "paymentDate": "2021-09-20T05:33:09.4477272",
25 "taxInfo": [
26 {
27 "regionName": "GBR",
28 "regionType": "Country",
29 "displayName": "United Kingdom",
30 "category": "Standard",
31 "rate": 20,
32 "amount": 1.667
33 }
34 ],
35 "priceItems": [
36 {
37 "thirdPartyRef": "TOM10234",
38 "supplierId": 123,
39 "price": 1,
40 "description": "Price Item Description",
41 "isGrossAmount": true,
42 "taxCategoryName": "Standard Category"
43 }
44 ]
45 },
46 "groupSubscriptionInfo": {
47 "licenseLevel": 1,
48 "overflowLevel": 0,
49 "subscriberList": [
50 {
51 "subscriptionId": 40000,
52 "emailAddress": "[email protected]",
53 "clientUserId": "testUser"
54 }
55 ],
56 "overFlowCount": 0,
57 "fullSubscriptionsCount": 1,
58 "currentUserInOverFlow": true,
59 "accountGroupToken": "00000000-0000-0000-0000-000000000000"
60 },
61 "voucherCodes": {
62 "voucherCode": "ABDR5467YY",
63 "discountPrice": 6
64 },
65 "customParameters": {
66 "name1": "value1"
67 }
68 },
69 "paymentScheduleInfo": {
70 "startDate": "2021-08-21T05:33:09.4477272",
71 "frequency": "Monthly",
72 "totalAmount": 10,
73 "paymentDayOffset": 10,
74 "paymentDay": 15,
75 "currency": "GBP",
76 "paymentMethod": "CreditDebitCard",
77 "scheduledPayments": [
78 {
79 "orderId": 1345,
80 "orderDate": "2021-09-19T05:33:09.4477272",
81 "status": "Completed",
82 "priceInfo": {
83 "grossAmount": 10,
84 "netAmount": 8.33,
85 "totalTaxAmount": 1.667,
86 "taxInfo": [
87 {
88 "regionName": "GBR",
89 "regionType": "Country",
90 "displayName": "United Kindom",
91 "category": "Standard",
92 "rate": 20,
93 "amount": 1.667
94 }
95 ]
96 }
97 }
98 ]
99 }
100 },
101 "defaultSubscriptionInfo": {
102 "customParameters": {
103 "Origin": "Facebook"
104 },
105 "subscriptionId": 40000,
106 "subscriptionStatus": "Active",
107 "subscriptionTitle": "SubscriptionTitle",
108 "subscriptionGroup": "SubscriptionGroup",
109 "licenseLevel": 0
110 }
111 },
112 {
113 "accountSubscriptionInfo": {
114 "expiryDate": "2021-09-21T05:33:09.4477272",
115 "firstNonDiscountedBillingPointUtc": "2021-08-21T05:33:09.4477272",
116 "lastDiscountedBillingPointUtc": "2021-07-21T05:33:09.4477272",
117 "paymentMethod": "CreditDebitCard",
118 "recurringPaymentInfo": {
119 "subscriptionReference": 223455,
120 "configuredSubscriptionPrice": 10,
121 "subscribedPrice": 11.21,
122 "currency": "USD",
123 "recurringPaymentEnable": false,
124 "subscriptionLockedIn": false,
125 "nextPaymentDate": "2021-10-21T05:33:09.4477272",
126 "previousBillingInfo": {
127 "subscriptionPriceId": 104852,
128 "totalAmount": 12,
129 "totalTaxAmount": 9.33,
130 "totalNetAmount": 2.667,
131 "billingDate": "2021-09-20T05:33:09.4477272",
132 "paymentDate": "2021-09-20T05:33:09.4477272",
133 "taxInfo": [
134 {
135 "regionName": "GBR",
136 "regionType": "Country",
137 "displayName": "United Kingdom",
138 "category": "Standard",
139 "rate": 20,
140 "amount": 1.667
141 }
142 ],
143 "priceItems": [
144 {
145 "thirdPartyRef": "TOM10234",
146 "supplierId": 123,
147 "price": 1,
148 "description": "Price Item Description",
149 "isGrossAmount": true,
150 "taxCategoryName": "Standard Category"
151 }
152 ]
153 },
154 "groupSubscriptionInfo": {
155 "licenseLevel": 1,
156 "overflowLevel": 0,
157 "subscriberList": [
158 {
159 "subscriptionId": 50000,
160 "emailAddress": "[email protected]",
161 "clientUserId": "testUser"
162 }
163 ],
164 "overFlowCount": 0,
165 "fullSubscriptionsCount": 1,
166 "currentUserInOverFlow": true,
167 "accountGroupToken": "00000000-0000-0000-0000-000000000000"
168 },
169 "voucherCodes": {
170 "voucherCode": "ABDR5467YY",
171 "discountPrice": 6
172 },
173 "customParameters": {
174 "name1": "value1"
175 }
176 },
177 "paymentScheduleInfo": {
178 "startDate": "2021-08-21T05:33:09.4477272",
179 "frequency": "Monthly",
180 "totalAmount": 11,
181 "paymentDayOffset": 10,
182 "paymentDay": 15,
183 "currency": "USD",
184 "paymentMethod": "CreditDebitCard",
185 "scheduledPayments": [
186 {
187 "orderId": 2345,
188 "orderDate": "2021-09-19T05:33:09.4477272",
189 "status": "Completed",
190 "priceInfo": {
191 "grossAmount": 12,
192 "netAmount": 9.33,
193 "totalTaxAmount": 2.667,
194 "taxInfo": [
195 {
196 "regionName": "USD",
197 "regionType": "Country",
198 "displayName": "United Kindom",
199 "category": "Standard",
200 "rate": 20,
201 "amount": 1.667
202 }
203 ]
204 }
205 }
206 ]
207 }
208 },
209 "defaultSubscriptionInfo": {
210 "customParameters": {
211 "Origin": "Facebook"
212 },
213 "subscriptionId": 50000,
214 "subscriptionStatus": "Active",
215 "subscriptionTitle": "SubscriptionTitle",
216 "subscriptionGroup": "SubscriptionGroup",
217 "licenseLevel": 0
218 }
219 }
220 ]
221}
Updated 22 Sep 2023
Did this page help you?