Retrieve an accounts subscriptions
1 min
GET
https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions
Path Parameters
- accountReferencestringrequired
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscriptionResultDescription
- subscriptionsFictiveGlobal.Api.Rest.Dtos.v3.AccountSubscription[]Description
- expiryDatestring<date-time>ExampleDescription
- firstNonDiscountedBillingPointUtcstring<date-time>ExampleDescription
- lastDiscountedBillingPointUtcstring<date-time>ExampleDescription
- paymentMethodstring<CreditDebitCard | ServiceCredit | ReverseBillSms | NotAvailable | ActivationCode | DirectDebit | Paypal | PagosPSE | BankTransfer | Offline | Itunes | Przelewy24 | GlobalCollect | Alipay | Smartlink | Momo | Roku | SPCarrierBilling | Boku | Amazon | GooglePlay | Sofort | Telstra | Trustly | IDeal | SEPA>Description
- recurringPaymentInfoFictiveGlobal.Api.Rest.Dtos.v2.RecurringPaymentInfoDescription
- shippingAddressReferencestringDescription
- invoiceAddressReferencestringDescription
- subscriptionReferenceinteger<int32>Description
- resourceReferencestringDescription
- cartReferencestringDescription
- configuredSubscriptionPricenumber<double>Description
- subscribedPricenumber<double>Description
- currencystring<ZZZ | GBP | EUR | USD | AUD | CAD | SEK | DKK | JPY | FictiveCREDITS | SAR | BGN | TWD | CZK | ILS | HUF | ISK | KRW | NOK | PLN | BRL | CHF | RON | RUB | HRK | ALL | THB | TRY | PKR | IDR | UAH | BYR | EEK | LVL | LTL | TJS | IRR | VND | AMD | AZN | MKD | ZAR | GEL | INR | MYR | KZT | KGS | KES | TMT | UZS | MNT | CNY | KHR | LAK | SYP | LKR | ETB | NPR | AFN | PHP | MVR | NIO | BOB | CLP | NZD | GTQ | RWF | XOF | IQD | MXN | CSD | BND | BDT | DZD | EGP | HKD | PEN | LYD | SGD | BAM | MOP | CRC | MAD | PAB | TND | DOP | OMR | JMD | VEB | YER | COP | RSD | BZD | JOD | TTD | ARS | LBP | ZWL | KWD | AED | UYU | BHD | PYG | QAR | HNL>Description
- recurringPaymentEnablebooleanDescription
- subscriptionLockedInbooleanDescription
- nextPaymentDatestring<date-time>ExampleDescription
- previousBillingInfoFictiveGlobal.Api.Rest.Dtos.v1.PreviousBillingInfoDescription
- subscriptionPriceIdinteger<int32>Description
- totalAmountnumber<double>Description
- totalTaxAmountnumber<double>Description
- totalNetAmountnumber<double>Description
- billingDatestring<date-time>ExampleDescription
- paymentDatestring<date-time>ExampleDescription
- taxInfoFictiveGlobal.Api.Rest.Dtos.v1.AccountTaxInfo[]Description
- regionNamestringDescription
- regionTypestring<ZeroRated | Country | State | County | City>Description
- displayNamestringDescription
- categorystringDescription
- ratenumber<double>Description
- amountnumber<double>Description
- priceItemsFictiveGlobal.Api.Rest.Dtos.v1.AccountPriceItem[]Description
- thirdPartyRefstringDescription
- supplierIdinteger<int32>Description
- pricenumber<double>Description
- descriptionstringDescription
- isGrossAmountbooleanDescription
- taxCategoryNamestringDescription
- groupSubscriptionInfoFictiveGlobal.Api.Rest.Dtos.v1.GroupSubscriptionInfoDescription
- licenseLevelinteger<int32>Description
- overflowLevelinteger<int32>Description
- subscriberListFictiveGlobal.Api.Rest.Dtos.v1.Subscriber[]Description
- subscriptionIdinteger<int32>Description
- emailAddressstringDescription
- clientUserIdstringDescription
- overFlowCountinteger<int32>Description
- fullSubscriptionsCountinteger<int32>Description
- currentUserInOverFlowbooleanDescription
- accountGroupTokenstringDescription
- voucherCodesFictiveGlobal.Api.Rest.Dtos.v1.AccountVoucherCodeDescription
- voucherCodestringDescription
- discountPricenumber<double>Description
- statusInfoFictiveGlobal.Api.Rest.Dtos.v1.SubscriptionStatusInfoDescription
- statusIdinteger<int32>Description
- statusDescriptionstring<CancelledByCustomerSupport | Active | Expired | CancelledByAutoRenew | CancelledByUser | PackPricingItemCancelled | CancelledByPayPalIPN | FailureRetryMode | CancelledByBACS | Pending | CancelledBySEPA | OnHoliday | OnHold>Description
- customParametersobjectExampleDescription
- bundleReferencestringDescription
- defaultSubscriptionInfoFictiveGlobal.Api.Rest.Dtos.v2.DefaultSubscriptionInfoDescription
- customParametersobjectExampleDescription
- subscriptionIdinteger<int32>Description
- subscriptionStatusstringDescription
- subscriptionTitlestringDescription
- subscriptionGroupstringDescription
- licenseLevelinteger<int32>Description
- contractReferencestringDescription
400
403
404
500
curl
curl --request GET \
--url https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions \
--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/accounts/{accountReference}/subscriptions", 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/accounts/{accountReference}/subscriptions")
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/accounts/{accountReference}/subscriptions"
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
{
"expiryDate": "2021-09-21T05:33:09.8539889",
"firstNonDiscountedBillingPointUtc": "2021-08-21T05:33:09.8539889",
"lastDiscountedBillingPointUtc": "2021-07-21T05:33:09.8539889",
"paymentMethod": "CreditDebitCard",
"recurringPaymentInfo": {
"subscriptionReference": 123455,
"resourceReference": "001PBOSKDO7X77G611",
"cartReference": "001PBB14NB7VMNQBE2",
"configuredSubscriptionPrice": 10,
"subscribedPrice": 10.21,
"currency": "GBP",
"recurringPaymentEnable": false,
"subscriptionLockedIn": false,
"nextPaymentDate": "2021-10-21T05:33:09.8539889",
"previousBillingInfo": {
"subscriptionPriceId": 94852,
"totalAmount": 10,
"totalTaxAmount": 8.33,
"totalNetAmount": 1.667,
"billingDate": "2021-09-20T05:33:09.8539889",
"paymentDate": "2021-09-20T05:33:09.8539889",
"taxInfo": [
{
"regionName": "GBR",
"regionType": "Country",
"displayName": "United Kingdom",
"category": "Standard",
"rate": 20,
"amount": 1.667
}
],
"priceItems": [
{
"thirdPartyRef": "TOM10234",
"supplierId": 123,
"price": 1,
"description": "Price Item Description",
"isGrossAmount": true,
"taxCategoryName": "Standard Category"
}
]
},
"groupSubscriptionInfo": {
"licenseLevel": 1,
"overflowLevel": 0,
"subscriberList": [
{
"subscriptionId": 40000,
"emailAddress": "[email protected]",
"clientUserId": "testUser"
}
],
"overFlowCount": 0,
"fullSubscriptionsCount": 1,
"currentUserInOverFlow": true,
"accountGroupToken": "00000000-0000-0000-0000-000000000000"
},
"voucherCodes": {
"voucherCode": "ABDR5467YY",
"discountPrice": 6
},
"customParameters": {
"name1": "value1"
},
"bundleReference": "001PBH22FJ3NI3O443"
},
"defaultSubscriptionInfo": {
"customParameters": {
"Origin": "Facebook"
},
"subscriptionId": 40000,
"subscriptionStatus": "Active",
"subscriptionTitle": "SubscriptionTitle",
"subscriptionGroup": "SubscriptionGroup",
"licenseLevel": 0,
"contractReference": "0001CH22FJ3NI3O443"
}
}400
// Request is invalid.
403
// Unable to authenticate using the provided session.
404
// No subscription found.
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.