--- title: Retrieve an accounts subscriptions slug: docs/demo/retrieve-an-accounts-subscriptions description: Learn how to make a GET request to the fictive API and efficiently retrieve account subscriptions with this code example. Enhance your understanding of API integration and improve your programming skills effortlessly. docTags: createdAt: 2022-03-21T20:12:45.000Z --- { "id": "ty2sTscbpsZIQ8TFhPxyC", "data": { "url": "https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions", "name": "Retrieve an accounts subscriptions", "method": "GET", "request": { "pathParameters": [ { "kind": "required", "name": "accountReference", "type": "string" } ], "queryParameters": [], "headerParameters": [ { "kind": "optional", "name": "X-TokenId", "type": "string", "description": "The eSuite Token Id" }, { "kind": "optional", "name": "X-SessionId", "type": "string", "description": "The eSuite Session Id" }, { "kind": "required", "name": "X-Version", "type": "string", "description": "The eSuite Version" }, { "kind": "optional", "name": "Origin", "type": "string", "description": "The eSuite Origin" } ], "bodyDataParameters": [], "formDataParameters": [] }, "responses": [ { "schema": [ { "kind": "optional", "type": "object", "schema": [ { "kind": "optional", "name": "subscriptions", "type": "array", "schema": [ { "kind": "optional", "name": "expiryDate", "type": "string", "example": "2021-09-21T05:33:09.6196027", "description": "Expiry Date" }, { "kind": "optional", "name": "firstNonDiscountedBillingPointUtc", "type": "string", "example": "2021-09-21T05:33:09.6196027", "description": "First Non Discounted Billing PointUTC" }, { "kind": "optional", "name": "lastDiscountedBillingPointUtc", "type": "string", "example": "2021-09-21T05:33:09.6196027", "description": "Last Discounted Billing PointUTC" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "Payment Method" }, { "kind": "optional", "name": "recurringPaymentInfo", "type": "object", "schema": [ { "kind": "optional", "name": "shippingAddressReference", "type": "string", "example": "", "description": "Shipping Address Reference" }, { "kind": "optional", "name": "invoiceAddressReference", "type": "string", "example": "", "description": "Invoice Address Reference" }, { "kind": "optional", "name": "subscriptionReference", "type": "integer", "example": 0, "description": "Subscription Reference" }, { "kind": "optional", "name": "resourceReference", "type": "string", "example": "", "description": "Unique Resource Reference" }, { "kind": "optional", "name": "cartReference", "type": "string", "example": "", "description": "Reference to the subscription's cart" }, { "kind": "optional", "name": "configuredSubscriptionPrice", "type": "number", "example": "", "description": "Configured Subscription Price" }, { "kind": "optional", "name": "subscribedPrice", "type": "number", "example": "", "description": "Subscribed Price" }, { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" }, { "kind": "optional", "name": "recurringPaymentEnable", "type": "boolean", "example": "", "description": "Recurring Payment Enable" }, { "kind": "optional", "name": "subscriptionLockedIn", "type": "boolean", "example": "", "description": "Subscription LockedIn" }, { "kind": "optional", "name": "nextPaymentDate", "type": "string", "example": "2021-09-21T05:33:09.6821452", "description": "Next Payment Date" }, { "kind": "optional", "name": "previousBillingInfo", "type": "object", "schema": [ { "kind": "optional", "name": "subscriptionPriceId", "type": "integer", "example": 0, "description": "Subscription Price Id" }, { "kind": "optional", "name": "totalAmount", "type": "number", "example": "", "description": "Total Amount" }, { "kind": "optional", "name": "totalTaxAmount", "type": "number", "example": "", "description": "Total Tax Amount" }, { "kind": "optional", "name": "totalNetAmount", "type": "number", "example": "", "description": "Total Net Amount" }, { "kind": "optional", "name": "billingDate", "type": "string", "example": "2021-09-21T05:33:08.932098", "description": "Billing Date" }, { "kind": "optional", "name": "paymentDate", "type": "string", "example": "2021-09-21T05:33:08.932098", "description": "Payment Date" }, { "kind": "optional", "name": "taxInfo", "type": "array", "schema": [ { "kind": "optional", "name": "regionName", "type": "string", "example": "", "description": "Region Name" }, { "kind": "optional", "name": "regionType", "type": "string", "example": "", "description": "Region Type" }, { "kind": "optional", "name": "displayName", "type": "string", "example": "", "description": "Display Name" }, { "kind": "optional", "name": "category", "type": "string", "example": "", "description": "Category" }, { "kind": "optional", "name": "rate", "type": "number", "example": "", "description": "Rate" }, { "kind": "optional", "name": "amount", "type": "number", "example": "", "description": "Amount" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.AccountTaxInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.AccountTaxInfo[]", "description": "Tax info" }, { "kind": "optional", "name": "priceItems", "type": "array", "schema": [ { "kind": "optional", "name": "thirdPartyRef", "type": "string", "example": "", "description": "Gets or sets the external reference." }, { "kind": "optional", "name": "supplierId", "type": "integer", "example": 0, "description": "Gets or sets the supplier id." }, { "kind": "optional", "name": "price", "type": "number", "example": "", "description": "Gets or sets the price." }, { "kind": "optional", "name": "description", "type": "string", "example": "", "description": "Gets or sets the description." }, { "kind": "optional", "name": "isGrossAmount", "type": "boolean", "example": "", "description": "Specify whether is groos amount" }, { "kind": "optional", "name": "taxCategoryName", "type": "string", "example": "", "description": "Tax Category Name" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.AccountPriceItem", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.AccountPriceItem[]", "description": "Price Items" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PreviousBillingInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PreviousBillingInfo", "description": "Previous Billing Info" }, { "kind": "optional", "name": "groupSubscriptionInfo", "type": "object", "schema": [ { "kind": "optional", "name": "licenseLevel", "type": "integer", "example": 0, "description": "License Level" }, { "kind": "optional", "name": "overflowLevel", "type": "integer", "example": 0, "description": "Overflow Level" }, { "kind": "optional", "name": "subscriberList", "type": "array", "schema": [ { "kind": "optional", "name": "subscriptionId", "type": "integer", "example": 0, "description": "SubscriptionId" }, { "kind": "optional", "name": "emailAddress", "type": "string", "example": "", "description": "Email Address" }, { "kind": "optional", "name": "clientUserId", "type": "string", "example": "", "description": "ClientUserId" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.Subscriber", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.Subscriber[]", "description": "Subscriber List" }, { "kind": "optional", "name": "overFlowCount", "type": "integer", "example": 0, "description": "Overflow Count" }, { "kind": "optional", "name": "fullSubscriptionsCount", "type": "integer", "example": 0, "description": "Full Subscriptions Count" }, { "kind": "optional", "name": "currentUserInOverFlow", "type": "boolean", "example": "", "description": "Specify whether Current User In OverFlow" }, { "kind": "optional", "name": "accountGroupToken", "type": "string", "example": "", "description": "The subscriptions associated account group token." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.GroupSubscriptionInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.GroupSubscriptionInfo", "description": "Group Subscription Info" }, { "kind": "optional", "name": "voucherCodes", "type": "object", "schema": [ { "kind": "optional", "name": "voucherCode", "type": "string", "example": "", "description": "Voucher Code" }, { "kind": "optional", "name": "discountPrice", "type": "number", "example": "", "description": "Discount Price" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.AccountVoucherCode", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.AccountVoucherCode", "description": "Voucher Codes" }, { "kind": "optional", "name": "statusInfo", "type": "object", "schema": [ { "kind": "optional", "name": "statusId", "type": "integer", "example": 0, "description": "Status id" }, { "kind": "optional", "name": "statusDescription", "type": "string", "example": "", "description": "Status description" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionStatusInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionStatusInfo", "description": "Subscription status info" }, { "kind": "optional", "name": "customParameters", "type": "object", "schema": [], "example": {}, "description": "Custom parameters" }, { "kind": "optional", "name": "bundleReference", "type": "string", "example": "", "description": "If the subscription is linked to a bundle, the bundle reference it is linked to" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.RecurringPaymentInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.RecurringPaymentInfo", "description": "Recurring Payment Info" }, { "kind": "optional", "name": "defaultSubscriptionInfo", "type": "object", "schema": [ { "kind": "optional", "name": "customParameters", "type": "object", "schema": [], "example": {}, "description": "Custom Parameters" }, { "kind": "optional", "name": "subscriptionId", "type": "integer", "example": 0, "description": "(Miss Named) The Service Id associated to the Subscription" }, { "kind": "optional", "name": "subscriptionStatus", "type": "string", "example": "", "description": "(Miss Named) The Service Status" }, { "kind": "optional", "name": "subscriptionTitle", "type": "string", "example": "", "description": "(Miss Named) The Service Title" }, { "kind": "optional", "name": "subscriptionGroup", "type": "string", "example": "", "description": "(Miss Named) The Service Group" }, { "kind": "optional", "name": "licenseLevel", "type": "integer", "example": 0, "description": "The service license level" }, { "kind": "optional", "name": "contractReference", "type": "string", "example": "", "description": "The Contract Reference associated to the Subscription" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.DefaultSubscriptionInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.DefaultSubscriptionInfo", "description": "(Miss Named) Service Info" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscription", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscription[]", "description": "Subscriptions" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscriptionResult", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscriptionResult", "isExpanded": true, "description": "Account Subscription result" } ], "isExpanded": true, "statusCode": "200", "description": "OK", "jsonExample": "{\n \"expiryDate\": \"2021-09-21T05:33:09.8539889\",\n \"firstNonDiscountedBillingPointUtc\": \"2021-08-21T05:33:09.8539889\",\n \"lastDiscountedBillingPointUtc\": \"2021-07-21T05:33:09.8539889\",\n \"paymentMethod\": \"CreditDebitCard\",\n \"recurringPaymentInfo\": {\n \"subscriptionReference\": 123455,\n \"resourceReference\": \"001PBOSKDO7X77G611\",\n \"cartReference\": \"001PBB14NB7VMNQBE2\",\n \"configuredSubscriptionPrice\": 10,\n \"subscribedPrice\": 10.21,\n \"currency\": \"GBP\",\n \"recurringPaymentEnable\": false,\n \"subscriptionLockedIn\": false,\n \"nextPaymentDate\": \"2021-10-21T05:33:09.8539889\",\n \"previousBillingInfo\": {\n \"subscriptionPriceId\": 94852,\n \"totalAmount\": 10,\n \"totalTaxAmount\": 8.33,\n \"totalNetAmount\": 1.667,\n \"billingDate\": \"2021-09-20T05:33:09.8539889\",\n \"paymentDate\": \"2021-09-20T05:33:09.8539889\",\n \"taxInfo\": [\n {\n \"regionName\": \"GBR\",\n \"regionType\": \"Country\",\n \"displayName\": \"United Kingdom\",\n \"category\": \"Standard\",\n \"rate\": 20,\n \"amount\": 1.667\n }\n ],\n \"priceItems\": [\n {\n \"thirdPartyRef\": \"TOM10234\",\n \"supplierId\": 123,\n \"price\": 1,\n \"description\": \"Price Item Description\",\n \"isGrossAmount\": true,\n \"taxCategoryName\": \"Standard Category\"\n }\n ]\n },\n \"groupSubscriptionInfo\": {\n \"licenseLevel\": 1,\n \"overflowLevel\": 0,\n \"subscriberList\": [\n {\n \"subscriptionId\": 40000,\n \"emailAddress\": \"testUser@test.test\",\n \"clientUserId\": \"testUser\"\n }\n ],\n \"overFlowCount\": 0,\n \"fullSubscriptionsCount\": 1,\n \"currentUserInOverFlow\": true,\n \"accountGroupToken\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"voucherCodes\": {\n \"voucherCode\": \"ABDR5467YY\",\n \"discountPrice\": 6\n },\n \"customParameters\": {\n \"name1\": \"value1\"\n },\n \"bundleReference\": \"001PBH22FJ3NI3O443\"\n },\n \"defaultSubscriptionInfo\": {\n \"customParameters\": {\n \"Origin\": \"Facebook\"\n },\n \"subscriptionId\": 40000,\n \"subscriptionStatus\": \"Active\",\n \"subscriptionTitle\": \"SubscriptionTitle\",\n \"subscriptionGroup\": \"SubscriptionGroup\",\n \"licenseLevel\": 0,\n \"contractReference\": \"0001CH22FJ3NI3O443\"\n }\n}" }, { "isExpanded": true, "statusCode": "400", "description": "Request is invalid.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "403", "description": "Unable to authenticate using the provided session.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "No subscription found.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "500", "description": "Internal Server Error.", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint will provide the ability to retrieve all subscription against an account", "examples": { "languages": [ { "id": "DmmJeYzlNm2_T7MXdFQZp", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "_N9RX4xHAyCmqzKtqF3Y-", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-version\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Ajmg4Hi1auO--nQBeGdmN", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-version\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "m_BGspf0eSamtK_9kdoSl", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-version': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "DmmJeYzlNm2_T7MXdFQZp" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "{\n \"expiryDate\": \"2021-09-21T05:33:09.8539889\",\n \"firstNonDiscountedBillingPointUtc\": \"2021-08-21T05:33:09.8539889\",\n \"lastDiscountedBillingPointUtc\": \"2021-07-21T05:33:09.8539889\",\n \"paymentMethod\": \"CreditDebitCard\",\n \"recurringPaymentInfo\": {\n \"subscriptionReference\": 123455,\n \"resourceReference\": \"001PBOSKDO7X77G611\",\n \"cartReference\": \"001PBB14NB7VMNQBE2\",\n \"configuredSubscriptionPrice\": 10,\n \"subscribedPrice\": 10.21,\n \"currency\": \"GBP\",\n \"recurringPaymentEnable\": false,\n \"subscriptionLockedIn\": false,\n \"nextPaymentDate\": \"2021-10-21T05:33:09.8539889\",\n \"previousBillingInfo\": {\n \"subscriptionPriceId\": 94852,\n \"totalAmount\": 10,\n \"totalTaxAmount\": 8.33,\n \"totalNetAmount\": 1.667,\n \"billingDate\": \"2021-09-20T05:33:09.8539889\",\n \"paymentDate\": \"2021-09-20T05:33:09.8539889\",\n \"taxInfo\": [\n {\n \"regionName\": \"GBR\",\n \"regionType\": \"Country\",\n \"displayName\": \"United Kingdom\",\n \"category\": \"Standard\",\n \"rate\": 20,\n \"amount\": 1.667\n }\n ],\n \"priceItems\": [\n {\n \"thirdPartyRef\": \"TOM10234\",\n \"supplierId\": 123,\n \"price\": 1,\n \"description\": \"Price Item Description\",\n \"isGrossAmount\": true,\n \"taxCategoryName\": \"Standard Category\"\n }\n ]\n },\n \"groupSubscriptionInfo\": {\n \"licenseLevel\": 1,\n \"overflowLevel\": 0,\n \"subscriberList\": [\n {\n \"subscriptionId\": 40000,\n \"emailAddress\": \"testUser@test.test\",\n \"clientUserId\": \"testUser\"\n }\n ],\n \"overFlowCount\": 0,\n \"fullSubscriptionsCount\": 1,\n \"currentUserInOverFlow\": true,\n \"accountGroupToken\": \"00000000-0000-0000-0000-000000000000\"\n },\n \"voucherCodes\": {\n \"voucherCode\": \"ABDR5467YY\",\n \"discountPrice\": 6\n },\n \"customParameters\": {\n \"name1\": \"value1\"\n },\n \"bundleReference\": \"001PBH22FJ3NI3O443\"\n },\n \"defaultSubscriptionInfo\": {\n \"customParameters\": {\n \"Origin\": \"Facebook\"\n },\n \"subscriptionId\": 40000,\n \"subscriptionStatus\": \"Active\",\n \"subscriptionTitle\": \"SubscriptionTitle\",\n \"subscriptionGroup\": \"SubscriptionGroup\",\n \"licenseLevel\": 0,\n \"contractReference\": \"0001CH22FJ3NI3O443\"\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// Request is invalid.\n" }, { "id": "response-2-403", "language": "403", "code": "// Unable to authenticate using the provided session.\n" }, { "id": "response-3-404", "language": "404", "code": "// No subscription found.\n" }, { "id": "response-4-500", "language": "500", "code": "// Internal Server Error.\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }