Retrieve Subscription Services
1 min
GET
https://api.fictive.com/REST/api/subscriptions
Query Parameters
- serviceReferencestring[]required
- subscriptionGroupTagNamestring
- statusesstring[]
- serviceTypesstring[]
- pageNumberstring
- resultsPerPagestring
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo[]Description
- contractReferencestringDescription
- subscriptionGroupstringDescription
- subscriptionGroupTagstringDescription
- subscriptionGroupStatusstring<Active | InActive>Description
- subscriptionDescriptionstringDescription
- subscriptionTitlestringDescription
- subscriptionTypestring<SubscriptionPeriod | FixedEndDate | PayPerView | PaymentSchedule | BundlePurchase | NotSpecified>Description
- subscriptionStatusstring<Active | InActive>Description
- initialPricingEnabledbooleanDescription
- trialInfoFictiveGlobal.Api.Rest.Dtos.v2.TrialInfoDescription
- trialEnabledbooleanDescription
- trialUnitstring<Unspecified | None | Minute | Hour | Day | Month | Year>Description
- trialPeriodinteger<int32>Description
- discountPercentagenumber<double>Description
- nonPaymentTrialbooleanDescription
- trialChargedAsSinglePeriodbooleanDescription
- contractInfoFictiveGlobal.Api.Rest.Dtos.v1.ContractInfoDescription
- contractUnitstring<Years | Months | Weeks | Days | Hours | Minutes | NotSpecified>Description
- contractPeriodinteger<int32>Description
- autoRenewDefaultstring<Enabled | Disabled>Description
- pricingInfoFictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing[]Description
- currencystringDescription
- initialPricenumber<double>Description
- priceIsGrossbooleanDescription
- renewalPricenumber<double>Description
- priceIdinteger<int32>Description
- taxCategorystringDescription
- resourceReferencestringDescription
- paymentMethodstringDescription
- rolestringDescription
- allowedPaymentMethodsstring[]ExampleDescription
- customParametersFictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter[]Description
- parameterNamestringDescription
- parameterTypestringDescription
- parameterValuestringDescription
- cancellationDetailsFictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetailsDescription
- cancellationOptionstring<NotConfigured | FullRefund | ProRataRefund | FullRefundInServiceCredits | ProRataRefundInServiceCredits>Description
- minimumRefundThresholdEnabledbooleanDescription
- minimumRefundThresholdsFictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails[]Description
- currencystringDescription
- amountnumber<double>Description
- imagesFictiveGlobal.Api.Rest.Dtos.v1.Image[]Description
- imageIdinteger<int32>Description
- displayNamestringDescription
- fileNamestringDescription
- defaultbooleanDescription
- locationstringDescription
- groupLicensingFictiveGlobal.Api.Rest.Dtos.v1.GroupLicensingDescription
- standardinteger<int32>Description
- overflowinteger<int32>Description
- paymentOptionsFictiveGlobal.Api.Rest.Dtos.v1.PaymentTypesDescription
- cardTypesFictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard[]Description
- namestringDescription
- allowRepeatsbooleanDescription
- use3DSecureForAllTransactionsbooleanDescription
- use3DSecureOnFirstTransactionbooleanDescription
- directDebitTypesFictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]Description
- namestringDescription
- allowedbooleanDescription
- bankTransferTypesFictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]Description
- namestringDescription
- allowedbooleanDescription
204
- FictiveGlobal.Api.Rest.Dtos.v3.SubscriptionInfo[]Description
- contractReferencestringDescription
- subscriptionGroupstringDescription
- subscriptionGroupTagstringDescription
- subscriptionGroupStatusstring<Active | InActive>Description
- subscriptionDescriptionstringDescription
- subscriptionTitlestringDescription
- subscriptionTypestring<SubscriptionPeriod | FixedEndDate | PayPerView | PaymentSchedule | BundlePurchase | NotSpecified>Description
- subscriptionStatusstring<Active | InActive>Description
- initialPricingEnabledbooleanDescription
- trialInfoFictiveGlobal.Api.Rest.Dtos.v2.TrialInfoDescription
- trialEnabledbooleanDescription
- trialUnitstring<Unspecified | None | Minute | Hour | Day | Month | Year>Description
- trialPeriodinteger<int32>Description
- discountPercentagenumber<double>Description
- nonPaymentTrialbooleanDescription
- trialChargedAsSinglePeriodbooleanDescription
- contractInfoFictiveGlobal.Api.Rest.Dtos.v1.ContractInfoDescription
- contractUnitstring<Years | Months | Weeks | Days | Hours | Minutes | NotSpecified>Description
- contractPeriodinteger<int32>Description
- autoRenewDefaultstring<Enabled | Disabled>Description
- pricingInfoFictiveGlobal.Api.Rest.Dtos.v2.SubscriptionPricing[]Description
- currencystringDescription
- initialPricenumber<double>Description
- priceIsGrossbooleanDescription
- renewalPricenumber<double>Description
- priceIdinteger<int32>Description
- taxCategorystringDescription
- resourceReferencestringDescription
- paymentMethodstringDescription
- rolestringDescription
- allowedPaymentMethodsstring[]ExampleDescription
- customParametersFictiveGlobal.Api.Rest.Dtos.v1.SubscriptionCustomParameter[]Description
- parameterNamestringDescription
- parameterTypestringDescription
- parameterValuestringDescription
- cancellationDetailsFictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationOptionDetailsDescription
- cancellationOptionstring<NotConfigured | FullRefund | ProRataRefund | FullRefundInServiceCredits | ProRataRefundInServiceCredits>Description
- minimumRefundThresholdEnabledbooleanDescription
- minimumRefundThresholdsFictiveGlobal.Api.Rest.Dtos.v1.ServiceCancellationThresholdDetails[]Description
- currencystringDescription
- amountnumber<double>Description
- imagesFictiveGlobal.Api.Rest.Dtos.v1.Image[]Description
- imageIdinteger<int32>Description
- displayNamestringDescription
- fileNamestringDescription
- defaultbooleanDescription
- locationstringDescription
- groupLicensingFictiveGlobal.Api.Rest.Dtos.v1.GroupLicensingDescription
- standardinteger<int32>Description
- overflowinteger<int32>Description
- paymentOptionsFictiveGlobal.Api.Rest.Dtos.v1.PaymentTypesDescription
- cardTypesFictiveGlobal.Api.Rest.Dtos.v1.CreditDebitCard[]Description
- namestringDescription
- allowRepeatsbooleanDescription
- use3DSecureForAllTransactionsbooleanDescription
- use3DSecureOnFirstTransactionbooleanDescription
- directDebitTypesFictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]Description
- namestringDescription
- allowedbooleanDescription
- bankTransferTypesFictiveGlobal.Api.Rest.Dtos.v1.PaymentType[]Description
- namestringDescription
- allowedbooleanDescription
400
404
500
curl
curl --request GET \
--url 'https://api.fictive.com/REST/api/subscriptions?serviceReference=array' \
--header 'accept: application/json' \
--header 'x-version: string'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-version", "string");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.fictive.com/REST/api/subscriptions?serviceReference=array", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.fictive.com/REST/api/subscriptions?serviceReference=array")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-version"] = "string"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.fictive.com/REST/api/subscriptions?serviceReference=array"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-version': 'string'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
[
{
"contractReference": "0010SGFC5SYCG6AEM3",
"subscriptionGroup": "Monthly Magazine",
"subscriptionGroupTag": "Monthly Subscription",
"subscriptionGroupStatus": "Active",
"subscriptionDescription": "Day Digital Monthly Subscription",
"subscriptionTitle": "Monthly",
"subscriptionType": "SubscriptionPeriod",
"subscriptionStatus": "Active",
"initialPricingEnabled": false,
"trialInfo": {
"trialEnabled": false,
"trialUnit": "Month",
"trialPeriod": 0,
"discountPercentage": 0,
"nonPaymentTrial": false,
"trialChargedAsSinglePeriod": false
},
"contractInfo": {
"contractUnit": "Minutes",
"contractPeriod": 5,
"autoRenewDefault": "Enabled"
},
"pricingInfo": [
{
"currency": "GBP",
"initialPrice": 0,
"priceIsGross": true,
"renewalPrice": 2.5,
"priceId": 16889,
"taxCategory": "Standard",
"resourceReference": "0010NWR3QDGG734QM2",
"paymentMethod": "eWallet",
"role": "Default"
}
],
"allowedPaymentMethods": [
"CreditCard",
"PayPal",
"DirectDebit",
"Cash",
"Cheque"
],
"customParameters": [
{
"parameterName": "ThirdPartyRef",
"parameterType": "String",
"parameterValue": "1221332525"
}
],
"cancellationDetails": {
"cancellationOption": "FullRefundInServiceCredits",
"minimumRefundThresholdEnabled": true,
"minimumRefundThresholds": [
{
"currency": "GBP",
"amount": 10.23
},
{
"currency": "EUR",
"amount": 11.99
}
]
},
"images": [
{
"imageId": 14,
"displayName": "TestImage",
"fileName": "433_62c5f972-80ad-4239-97fc-428eb93916e8",
"default": true,
"location": "https://s3-eu-west-1.amazonaws.com/Fictive-dev-one/433_62c5f972-80ad-4239-97fc-428eb93916e8"
}
],
"groupLicensing": {
"standard": 1,
"overflow": 0
},
"paymentOptions": {
"cardTypes": [
{
"name": "Visa",
"allowRepeats": false,
"use3DSecureForAllTransactions": true,
"use3DSecureOnFirstTransaction": false
}
],
"directDebitTypes": [
{
"name": "Bacs",
"allowed": true
},
{
"name": "Sepa",
"allowed": true
}
],
"bankTransferTypes": [
{
"name": "Alipay",
"allowed": true
},
{
"name": "GlobalCollect",
"allowed": false
},
{
"name": "Momo",
"allowed": true
},
{
"name": "Przelewy24",
"allowed": false
},
{
"name": "Smartlink",
"allowed": false
}
]
}
}
]204
// No Content
[
{
"contractReference": "",
"subscriptionGroup": "",
"subscriptionGroupTag": "",
"subscriptionGroupStatus": "",
"subscriptionDescription": "",
"subscriptionTitle": "",
"subscriptionType": "",
"subscriptionStatus": "",
"initialPricingEnabled": false,
"trialInfo": {
"trialEnabled": false,
"trialUnit": "",
"trialPeriod": "",
"discountPercentage": "",
"nonPaymentTrial": false,
"trialChargedAsSinglePeriod": false
},
"contractInfo": {
"contractUnit": "",
"contractPeriod": "",
"autoRenewDefault": ""
},
"pricingInfo": [
{
"currency": "",
"initialPrice": "",
"priceIsGross": false,
"renewalPrice": "",
"priceId": "",
"taxCategory": "",
"resourceReference": "",
"paymentMethod": "",
"role": ""
}
],
"allowedPaymentMethods": [
""
],
"customParameters": [
{
"parameterName": "",
"parameterType": "",
"parameterValue": ""
}
],
"cancellationDetails": {
"cancellationOption": "",
"minimumRefundThresholdEnabled": false,
"minimumRefundThresholds": [
{
"currency": "",
"amount": ""
}
]
},
"images": [
{
"imageId": "",
"displayName": "",
"fileName": "",
"default": false,
"location": ""
}
],
"groupLicensing": {
"standard": "",
"overflow": ""
},
"paymentOptions": {
"cardTypes": [
{
"name": "",
"allowRepeats": false,
"use3DSecureForAllTransactions": false,
"use3DSecureOnFirstTransaction": false
}
],
"directDebitTypes": [
{
"name": "",
"allowed": false
}
],
"bankTransferTypes": [
{
"name": "",
"allowed": false
}
]
}
}
]400
// •Request is invalid.
404
// •No subscription found.
•The ServiceGroup specified does not exist.
500
// •Internal Server Error.
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.