--- title: Retrieve Subscription Services slug: docs/demo/retrieve-subscription-services description: Learn how to make a GET request to an API endpoint using cURL command with this code example. Get insights on the URL structure, necessary headers for Accept and Content-Type, and the request method for smooth API integration. createdAt: 2022-03-21T20:12:45.000Z --- { "id": "abVNQP7SRcU1oj9gns4Bp", "data": { "url": "https://api.fictive.com/REST/api/subscriptions", "name": "Retrieve Subscription Services", "method": "GET", "request": { "pathParameters": [], "queryParameters": [ { "kind": "required", "name": "serviceReference", "type": "array", "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "subscriptionGroupTagName", "type": "string" }, { "kind": "optional", "name": "statuses", "type": "array", "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "serviceTypes", "type": "array", "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "pageNumber", "type": "string" }, { "kind": "optional", "name": "resultsPerPage", "type": "string" } ], "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": "array", "schema": [ { "kind": "optional", "name": "contractReference", "type": "string", "example": "", "description": "Contract reference" }, { "kind": "optional", "name": "subscriptionGroup", "type": "string", "example": "", "description": "Subscription group" }, { "kind": "optional", "name": "subscriptionGroupTag", "type": "string", "example": "", "description": "Subscription group tag" }, { "kind": "optional", "name": "subscriptionGroupStatus", "type": "string", "example": "", "description": "Subscription group status" }, { "kind": "optional", "name": "subscriptionDescription", "type": "string", "example": "", "description": "Subscription description" }, { "kind": "optional", "name": "subscriptionTitle", "type": "string", "example": "", "description": "Subscription title" }, { "kind": "optional", "name": "subscriptionType", "type": "string", "example": "", "description": "Subscription type" }, { "kind": "optional", "name": "subscriptionStatus", "type": "string", "example": "", "description": "Subscription status" }, { "kind": "optional", "name": "initialPricingEnabled", "type": "boolean", "example": "", "description": "Initial pricing enabled" }, { "kind": "optional", "name": "trialInfo", "type": "object", "schema": [ { "kind": "optional", "name": "trialEnabled", "type": "boolean", "example": "", "description": "Trial enabled" }, { "kind": "optional", "name": "trialUnit", "type": "string", "example": "", "description": "Trial unit" }, { "kind": "optional", "name": "trialPeriod", "type": "integer", "example": 0, "description": "Trial period" }, { "kind": "optional", "name": "discountPercentage", "type": "number", "example": "", "description": "Discount percentage" }, { "kind": "optional", "name": "nonPaymentTrial", "type": "boolean", "example": "", "description": "Non payment trial" }, { "kind": "optional", "name": "trialChargedAsSinglePeriod", "type": "boolean", "example": "", "description": "Trial charged as single period" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.TrialInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.TrialInfo", "description": "Trial info" }, { "kind": "optional", "name": "contractInfo", "type": "object", "schema": [ { "kind": "optional", "name": "contractUnit", "type": "string", "example": "", "description": "Contract Unit" }, { "kind": "optional", "name": "contractPeriod", "type": "integer", "example": 0, "description": "Contract period" }, { "kind": "optional", "name": "autoRenewDefault", "type": "string", "example": "", "description": "Auto renew default" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ContractInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ContractInfo", "description": "Contract info" }, { "kind": "optional", "name": "pricingInfo", "type": "array", "schema": [ { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" }, { "kind": "optional", "name": "initialPrice", "type": "number", "example": "", "description": "Initial price" }, { "kind": "optional", "name": "priceIsGross", "type": "boolean", "example": "", "description": "Price is gross" }, { "kind": "optional", "name": "renewalPrice", "type": "number", "example": "", "description": "Renewal price" }, { "kind": "optional", "name": "priceId", "type": "integer", "example": 0, "description": "Price id" }, { "kind": "optional", "name": "taxCategory", "type": "string", "example": "", "description": "Tax category" }, { "kind": "optional", "name": "resourceReference", "type": "string", "example": "", "description": "Resource reference" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "Payment Method" }, { "kind": "optional", "name": "role", "type": "string", "example": "", "description": "Role Title" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing[]", "description": "Subscription pricing" }, { "kind": "optional", "name": "allowedPaymentMethods", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Alowed payment methods", "itemExample": "" }, { "kind": "optional", "name": "customParameters", "type": "array", "schema": [ { "kind": "optional", "name": "parameterName", "type": "string", "example": "", "description": "Name of the custom parameter" }, { "kind": "optional", "name": "parameterType", "type": "string", "example": "", "description": "Parameter type" }, { "kind": "optional", "name": "parameterValue", "type": "string", "example": "", "description": "Value of the custom parameter" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter[]", "description": "Custom parameters" }, { "kind": "optional", "name": "cancellationDetails", "type": "object", "schema": [ { "kind": "optional", "name": "cancellationOption", "type": "string", "example": "", "description": "Cancellation option type" }, { "kind": "optional", "name": "minimumRefundThresholdEnabled", "type": "boolean", "example": "", "description": "Refund threshold enabled" }, { "kind": "optional", "name": "minimumRefundThresholds", "type": "array", "schema": [ { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" }, { "kind": "optional", "name": "amount", "type": "number", "example": "", "description": "Value" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails[]", "description": "List of all refund thresholds" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetails", "description": "Service Cancellation Options" }, { "kind": "optional", "name": "images", "type": "array", "schema": [ { "kind": "optional", "name": "imageId", "type": "integer", "example": 0, "description": "Image identifier" }, { "kind": "optional", "name": "displayName", "type": "string", "example": "", "description": "Display name" }, { "kind": "optional", "name": "fileName", "type": "string", "example": "", "description": "File name" }, { "kind": "optional", "name": "default", "type": "boolean", "example": "", "description": "Specify if image is default" }, { "kind": "optional", "name": "location", "type": "string", "example": "", "description": "Path to the image" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.Image", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.Image[]", "description": "Images" }, { "kind": "optional", "name": "groupLicensing", "type": "object", "schema": [ { "kind": "optional", "name": "standard", "type": "integer", "example": 0, "description": "Standard" }, { "kind": "optional", "name": "overflow", "type": "integer", "example": 0, "description": "Overflow" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.GroupLicensing", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.GroupLicensing", "description": "Group licensing" }, { "kind": "optional", "name": "paymentOptions", "type": "object", "schema": [ { "kind": "optional", "name": "cardTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowRepeats", "type": "boolean", "example": "", "description": "Gets or set the allow repeats" }, { "kind": "optional", "name": "use3DSecureForAllTransactions", "type": "boolean", "example": "", "description": "Gets or set the Use3DSecureForAllTransactions" }, { "kind": "optional", "name": "use3DSecureOnFirstTransaction", "type": "boolean", "example": "", "description": "Gets or set the Use3DSecureOnFirstTransaction" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard[]", "description": "Gets or set the card types" }, { "kind": "optional", "name": "directDebitTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowed", "type": "boolean", "example": "", "description": "Gets or set the allowed" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentType", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]", "description": "Gets or set the direct debit types" }, { "kind": "optional", "name": "bankTransferTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowed", "type": "boolean", "example": "", "description": "Gets or set the allowed" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentType", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]", "description": "Gets or set the bank transfer types" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentTypes", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentTypes", "description": "Gets or sets the payment options." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo[]", "isExpanded": true, "description": "Subscription info" } ], "isExpanded": true, "statusCode": "200", "description": "OK", "jsonExample": "[\n {\n \"contractReference\": \"0010SGFC5SYCG6AEM3\",\n \"subscriptionGroup\": \"Monthly Magazine\",\n \"subscriptionGroupTag\": \"Monthly Subscription\",\n \"subscriptionGroupStatus\": \"Active\",\n \"subscriptionDescription\": \"Day Digital Monthly Subscription\",\n \"subscriptionTitle\": \"Monthly\",\n \"subscriptionType\": \"SubscriptionPeriod\",\n \"subscriptionStatus\": \"Active\",\n \"initialPricingEnabled\": false,\n \"trialInfo\": {\n \"trialEnabled\": false,\n \"trialUnit\": \"Month\",\n \"trialPeriod\": 0,\n \"discountPercentage\": 0,\n \"nonPaymentTrial\": false,\n \"trialChargedAsSinglePeriod\": false\n },\n \"contractInfo\": {\n \"contractUnit\": \"Minutes\",\n \"contractPeriod\": 5,\n \"autoRenewDefault\": \"Enabled\"\n },\n \"pricingInfo\": [\n {\n \"currency\": \"GBP\",\n \"initialPrice\": 0,\n \"priceIsGross\": true,\n \"renewalPrice\": 2.5,\n \"priceId\": 16889,\n \"taxCategory\": \"Standard\",\n \"resourceReference\": \"0010NWR3QDGG734QM2\",\n \"paymentMethod\": \"eWallet\",\n \"role\": \"Default\"\n }\n ],\n \"allowedPaymentMethods\": [\n \"CreditCard\",\n \"PayPal\",\n \"DirectDebit\",\n \"Cash\",\n \"Cheque\"\n ],\n \"customParameters\": [\n {\n \"parameterName\": \"ThirdPartyRef\",\n \"parameterType\": \"String\",\n \"parameterValue\": \"1221332525\"\n }\n ],\n \"cancellationDetails\": {\n \"cancellationOption\": \"FullRefundInServiceCredits\",\n \"minimumRefundThresholdEnabled\": true,\n \"minimumRefundThresholds\": [\n {\n \"currency\": \"GBP\",\n \"amount\": 10.23\n },\n {\n \"currency\": \"EUR\",\n \"amount\": 11.99\n }\n ]\n },\n \"images\": [\n {\n \"imageId\": 14,\n \"displayName\": \"TestImage\",\n \"fileName\": \"433_62c5f972-80ad-4239-97fc-428eb93916e8\",\n \"default\": true,\n \"location\": \"https://s3-eu-west-1.amazonaws.com/Fictive-dev-one/433_62c5f972-80ad-4239-97fc-428eb93916e8\"\n }\n ],\n \"groupLicensing\": {\n \"standard\": 1,\n \"overflow\": 0\n },\n \"paymentOptions\": {\n \"cardTypes\": [\n {\n \"name\": \"Visa\",\n \"allowRepeats\": false,\n \"use3DSecureForAllTransactions\": true,\n \"use3DSecureOnFirstTransaction\": false\n }\n ],\n \"directDebitTypes\": [\n {\n \"name\": \"Bacs\",\n \"allowed\": true\n },\n {\n \"name\": \"Sepa\",\n \"allowed\": true\n }\n ],\n \"bankTransferTypes\": [\n {\n \"name\": \"Alipay\",\n \"allowed\": true\n },\n {\n \"name\": \"GlobalCollect\",\n \"allowed\": false\n },\n {\n \"name\": \"Momo\",\n \"allowed\": true\n },\n {\n \"name\": \"Przelewy24\",\n \"allowed\": false\n },\n {\n \"name\": \"Smartlink\",\n \"allowed\": false\n }\n ]\n }\n }\n]" }, { "schema": [ { "kind": "optional", "type": "array", "schema": [ { "kind": "optional", "name": "contractReference", "type": "string", "example": "", "description": "Contract reference" }, { "kind": "optional", "name": "subscriptionGroup", "type": "string", "example": "", "description": "Subscription group" }, { "kind": "optional", "name": "subscriptionGroupTag", "type": "string", "example": "", "description": "Subscription group tag" }, { "kind": "optional", "name": "subscriptionGroupStatus", "type": "string", "example": "", "description": "Subscription group status" }, { "kind": "optional", "name": "subscriptionDescription", "type": "string", "example": "", "description": "Subscription description" }, { "kind": "optional", "name": "subscriptionTitle", "type": "string", "example": "", "description": "Subscription title" }, { "kind": "optional", "name": "subscriptionType", "type": "string", "example": "", "description": "Subscription type" }, { "kind": "optional", "name": "subscriptionStatus", "type": "string", "example": "", "description": "Subscription status" }, { "kind": "optional", "name": "initialPricingEnabled", "type": "boolean", "example": "", "description": "Initial pricing enabled" }, { "kind": "optional", "name": "trialInfo", "type": "object", "schema": [ { "kind": "optional", "name": "trialEnabled", "type": "boolean", "example": "", "description": "Trial enabled" }, { "kind": "optional", "name": "trialUnit", "type": "string", "example": "", "description": "Trial unit" }, { "kind": "optional", "name": "trialPeriod", "type": "integer", "example": 0, "description": "Trial period" }, { "kind": "optional", "name": "discountPercentage", "type": "number", "example": "", "description": "Discount percentage" }, { "kind": "optional", "name": "nonPaymentTrial", "type": "boolean", "example": "", "description": "Non payment trial" }, { "kind": "optional", "name": "trialChargedAsSinglePeriod", "type": "boolean", "example": "", "description": "Trial charged as single period" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.TrialInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.TrialInfo", "description": "Trial info" }, { "kind": "optional", "name": "contractInfo", "type": "object", "schema": [ { "kind": "optional", "name": "contractUnit", "type": "string", "example": "", "description": "Contract Unit" }, { "kind": "optional", "name": "contractPeriod", "type": "integer", "example": 0, "description": "Contract period" }, { "kind": "optional", "name": "autoRenewDefault", "type": "string", "example": "", "description": "Auto renew default" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ContractInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ContractInfo", "description": "Contract info" }, { "kind": "optional", "name": "pricingInfo", "type": "array", "schema": [ { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" }, { "kind": "optional", "name": "initialPrice", "type": "number", "example": "", "description": "Initial price" }, { "kind": "optional", "name": "priceIsGross", "type": "boolean", "example": "", "description": "Price is gross" }, { "kind": "optional", "name": "renewalPrice", "type": "number", "example": "", "description": "Renewal price" }, { "kind": "optional", "name": "priceId", "type": "integer", "example": 0, "description": "Price id" }, { "kind": "optional", "name": "taxCategory", "type": "string", "example": "", "description": "Tax category" }, { "kind": "optional", "name": "resourceReference", "type": "string", "example": "", "description": "Resource reference" }, { "kind": "optional", "name": "paymentMethod", "type": "string", "example": "", "description": "Payment Method" }, { "kind": "optional", "name": "role", "type": "string", "example": "", "description": "Role Title" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing", "customType": "FictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing[]", "description": "Subscription pricing" }, { "kind": "optional", "name": "allowedPaymentMethods", "type": "array", "example": [], "itemType": "string", "customType": "string[]", "description": "Alowed payment methods", "itemExample": "" }, { "kind": "optional", "name": "customParameters", "type": "array", "schema": [ { "kind": "optional", "name": "parameterName", "type": "string", "example": "", "description": "Name of the custom parameter" }, { "kind": "optional", "name": "parameterType", "type": "string", "example": "", "description": "Parameter type" }, { "kind": "optional", "name": "parameterValue", "type": "string", "example": "", "description": "Value of the custom parameter" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter[]", "description": "Custom parameters" }, { "kind": "optional", "name": "cancellationDetails", "type": "object", "schema": [ { "kind": "optional", "name": "cancellationOption", "type": "string", "example": "", "description": "Cancellation option type" }, { "kind": "optional", "name": "minimumRefundThresholdEnabled", "type": "boolean", "example": "", "description": "Refund threshold enabled" }, { "kind": "optional", "name": "minimumRefundThresholds", "type": "array", "schema": [ { "kind": "optional", "name": "currency", "type": "string", "example": "", "description": "Currency" }, { "kind": "optional", "name": "amount", "type": "number", "example": "", "description": "Value" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails[]", "description": "List of all refund thresholds" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetails", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetails", "description": "Service Cancellation Options" }, { "kind": "optional", "name": "images", "type": "array", "schema": [ { "kind": "optional", "name": "imageId", "type": "integer", "example": 0, "description": "Image identifier" }, { "kind": "optional", "name": "displayName", "type": "string", "example": "", "description": "Display name" }, { "kind": "optional", "name": "fileName", "type": "string", "example": "", "description": "File name" }, { "kind": "optional", "name": "default", "type": "boolean", "example": "", "description": "Specify if image is default" }, { "kind": "optional", "name": "location", "type": "string", "example": "", "description": "Path to the image" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.Image", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.Image[]", "description": "Images" }, { "kind": "optional", "name": "groupLicensing", "type": "object", "schema": [ { "kind": "optional", "name": "standard", "type": "integer", "example": 0, "description": "Standard" }, { "kind": "optional", "name": "overflow", "type": "integer", "example": 0, "description": "Overflow" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.GroupLicensing", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.GroupLicensing", "description": "Group licensing" }, { "kind": "optional", "name": "paymentOptions", "type": "object", "schema": [ { "kind": "optional", "name": "cardTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowRepeats", "type": "boolean", "example": "", "description": "Gets or set the allow repeats" }, { "kind": "optional", "name": "use3DSecureForAllTransactions", "type": "boolean", "example": "", "description": "Gets or set the Use3DSecureForAllTransactions" }, { "kind": "optional", "name": "use3DSecureOnFirstTransaction", "type": "boolean", "example": "", "description": "Gets or set the Use3DSecureOnFirstTransaction" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard[]", "description": "Gets or set the card types" }, { "kind": "optional", "name": "directDebitTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowed", "type": "boolean", "example": "", "description": "Gets or set the allowed" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentType", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]", "description": "Gets or set the direct debit types" }, { "kind": "optional", "name": "bankTransferTypes", "type": "array", "schema": [ { "kind": "optional", "name": "name", "type": "string", "example": "", "description": "Gets or set the name" }, { "kind": "optional", "name": "allowed", "type": "boolean", "example": "", "description": "Gets or set the allowed" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentType", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]", "description": "Gets or set the bank transfer types" } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v1.PaymentTypes", "customType": "FictiveGlobal.Api.Rest.Dtos.v1.PaymentTypes", "description": "Gets or sets the payment options." } ], "modelRef": "#/definitions/FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo", "customType": "FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo[]", "isExpanded": true, "description": "Subscription info" } ], "isExpanded": true, "statusCode": "204", "description": "No Content", "jsonExample": "" }, { "isExpanded": true, "statusCode": "400", "description": "•Request is invalid.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "404", "description": "•No subscription found.\r\n
•The ServiceGroup specified does not exist.", "jsonExample": "" }, { "isExpanded": true, "statusCode": "500", "description": "•Internal Server Error.", "jsonExample": "" } ], "contentType": "application/json", "description": "This endpoint allows for the filtering of subscription services returned on the eSuite API.", "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.fictive.com/REST/api/subscriptions?serviceReference=array' \\\n --header 'accept: application/json' \\\n --header 'x-version: string'" }, { "id": "example-1-javascript", "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/subscriptions?serviceReference=array\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.fictive.com/REST/api/subscriptions?serviceReference=array\")\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": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.fictive.com/REST/api/subscriptions?serviceReference=array\"\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": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "[\n {\n \"contractReference\": \"0010SGFC5SYCG6AEM3\",\n \"subscriptionGroup\": \"Monthly Magazine\",\n \"subscriptionGroupTag\": \"Monthly Subscription\",\n \"subscriptionGroupStatus\": \"Active\",\n \"subscriptionDescription\": \"Day Digital Monthly Subscription\",\n \"subscriptionTitle\": \"Monthly\",\n \"subscriptionType\": \"SubscriptionPeriod\",\n \"subscriptionStatus\": \"Active\",\n \"initialPricingEnabled\": false,\n \"trialInfo\": {\n \"trialEnabled\": false,\n \"trialUnit\": \"Month\",\n \"trialPeriod\": 0,\n \"discountPercentage\": 0,\n \"nonPaymentTrial\": false,\n \"trialChargedAsSinglePeriod\": false\n },\n \"contractInfo\": {\n \"contractUnit\": \"Minutes\",\n \"contractPeriod\": 5,\n \"autoRenewDefault\": \"Enabled\"\n },\n \"pricingInfo\": [\n {\n \"currency\": \"GBP\",\n \"initialPrice\": 0,\n \"priceIsGross\": true,\n \"renewalPrice\": 2.5,\n \"priceId\": 16889,\n \"taxCategory\": \"Standard\",\n \"resourceReference\": \"0010NWR3QDGG734QM2\",\n \"paymentMethod\": \"eWallet\",\n \"role\": \"Default\"\n }\n ],\n \"allowedPaymentMethods\": [\n \"CreditCard\",\n \"PayPal\",\n \"DirectDebit\",\n \"Cash\",\n \"Cheque\"\n ],\n \"customParameters\": [\n {\n \"parameterName\": \"ThirdPartyRef\",\n \"parameterType\": \"String\",\n \"parameterValue\": \"1221332525\"\n }\n ],\n \"cancellationDetails\": {\n \"cancellationOption\": \"FullRefundInServiceCredits\",\n \"minimumRefundThresholdEnabled\": true,\n \"minimumRefundThresholds\": [\n {\n \"currency\": \"GBP\",\n \"amount\": 10.23\n },\n {\n \"currency\": \"EUR\",\n \"amount\": 11.99\n }\n ]\n },\n \"images\": [\n {\n \"imageId\": 14,\n \"displayName\": \"TestImage\",\n \"fileName\": \"433_62c5f972-80ad-4239-97fc-428eb93916e8\",\n \"default\": true,\n \"location\": \"https://s3-eu-west-1.amazonaws.com/Fictive-dev-one/433_62c5f972-80ad-4239-97fc-428eb93916e8\"\n }\n ],\n \"groupLicensing\": {\n \"standard\": 1,\n \"overflow\": 0\n },\n \"paymentOptions\": {\n \"cardTypes\": [\n {\n \"name\": \"Visa\",\n \"allowRepeats\": false,\n \"use3DSecureForAllTransactions\": true,\n \"use3DSecureOnFirstTransaction\": false\n }\n ],\n \"directDebitTypes\": [\n {\n \"name\": \"Bacs\",\n \"allowed\": true\n },\n {\n \"name\": \"Sepa\",\n \"allowed\": true\n }\n ],\n \"bankTransferTypes\": [\n {\n \"name\": \"Alipay\",\n \"allowed\": true\n },\n {\n \"name\": \"GlobalCollect\",\n \"allowed\": false\n },\n {\n \"name\": \"Momo\",\n \"allowed\": true\n },\n {\n \"name\": \"Przelewy24\",\n \"allowed\": false\n },\n {\n \"name\": \"Smartlink\",\n \"allowed\": false\n }\n ]\n }\n }\n]" }, { "id": "response-1-204", "language": "204", "code": "// No Content\n[\n {\n \"contractReference\": \"\",\n \"subscriptionGroup\": \"\",\n \"subscriptionGroupTag\": \"\",\n \"subscriptionGroupStatus\": \"\",\n \"subscriptionDescription\": \"\",\n \"subscriptionTitle\": \"\",\n \"subscriptionType\": \"\",\n \"subscriptionStatus\": \"\",\n \"initialPricingEnabled\": false,\n \"trialInfo\": {\n \"trialEnabled\": false,\n \"trialUnit\": \"\",\n \"trialPeriod\": \"\",\n \"discountPercentage\": \"\",\n \"nonPaymentTrial\": false,\n \"trialChargedAsSinglePeriod\": false\n },\n \"contractInfo\": {\n \"contractUnit\": \"\",\n \"contractPeriod\": \"\",\n \"autoRenewDefault\": \"\"\n },\n \"pricingInfo\": [\n {\n \"currency\": \"\",\n \"initialPrice\": \"\",\n \"priceIsGross\": false,\n \"renewalPrice\": \"\",\n \"priceId\": \"\",\n \"taxCategory\": \"\",\n \"resourceReference\": \"\",\n \"paymentMethod\": \"\",\n \"role\": \"\"\n }\n ],\n \"allowedPaymentMethods\": [\n \"\"\n ],\n \"customParameters\": [\n {\n \"parameterName\": \"\",\n \"parameterType\": \"\",\n \"parameterValue\": \"\"\n }\n ],\n \"cancellationDetails\": {\n \"cancellationOption\": \"\",\n \"minimumRefundThresholdEnabled\": false,\n \"minimumRefundThresholds\": [\n {\n \"currency\": \"\",\n \"amount\": \"\"\n }\n ]\n },\n \"images\": [\n {\n \"imageId\": \"\",\n \"displayName\": \"\",\n \"fileName\": \"\",\n \"default\": false,\n \"location\": \"\"\n }\n ],\n \"groupLicensing\": {\n \"standard\": \"\",\n \"overflow\": \"\"\n },\n \"paymentOptions\": {\n \"cardTypes\": [\n {\n \"name\": \"\",\n \"allowRepeats\": false,\n \"use3DSecureForAllTransactions\": false,\n \"use3DSecureOnFirstTransaction\": false\n }\n ],\n \"directDebitTypes\": [\n {\n \"name\": \"\",\n \"allowed\": false\n }\n ],\n \"bankTransferTypes\": [\n {\n \"name\": \"\",\n \"allowed\": false\n }\n ]\n }\n }\n]" }, { "id": "response-2-400", "language": "400", "code": "// •Request is invalid.\n" }, { "id": "response-3-404", "language": "404", "code": "// •No subscription found.\r\n •The ServiceGroup specified does not exist.\n" }, { "id": "response-4-500", "language": "500", "code": "// •Internal Server Error.\n" } ], "selectedLanguageId": "response-0-200" } }, "type": "api-oas-v2", "children": [ { "text": "" } ] }