Retrieve an accounts subscriptions

1min
GET
This endpoint will provide the ability to retrieve all subscription against an account
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Responses
200
OK
FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscriptionResult
Description
Account Subscription result
subscriptions
FictiveGlobal.Api.Rest.Dtos.v3.AccountSubscription[]
400
Request is invalid.
403
Unable to authenticate using the provided session.
404
No subscription found.
500
Internal Server Error.
Curl
JS
Ruby
Python
curl --location --globoff 'https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
403
404
500
{
  "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"
  }
}
{
  "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": "testUser@test.test",
          "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"
  }
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Add Member to Subscription
Initiate a subscription purchase