Update Subscription Attributes

1min
PATCH
This endpoint will allow you the ability to amend the following attributes of the subscription: status, custom attributes, shippingAddress and invoiceAddress
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
subscriptionReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
subscriptionPatchRequest
Microsoft.AspNet.JsonPatch.JsonPatchDocument[FictiveGlobal.Api.Rest.Dtos.v2.Patch.Subscriptions.SubscriptionPatchModel]
*
value
System.Object
path
string
op
string
from
string
Responses
200
OK
FictiveGlobal.Api.Rest.Dtos.v2.AccountSubscriptionResult
Description
Account Subscription result
subscriptions
FictiveGlobal.Api.Rest.Dtos.v2.AccountSubscription[]
400
Request is invalid.
            <br /> Duplicate parameter {ParameterName} specified.
            <br /> The specified parameters are invalid.
403
Unable to authenticate using the provided session.
404
No subscription found or provided address not found.
412
Patch operation validation Error.
            <br /> The property at path '/CustomSubscriptionParameter/{parameterValue}' could not be removed.
500
Internal Server Error.
Curl
JS
Ruby
Python
curl --location --globoff --request PATCH 'https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
  {}
]'
curl --location --globoff --request PATCH 'https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '[
  {}
]'
Responses
200
400
403
404
412
500
{
  "accountSubscriptionInfo": {
    "startDate": "2021-09-21T05:33:10.7915055",
    "expiryDate": "2021-10-01T05:33:10.7915055",
    "cancellationDate": "2021-10-01T05:33:10.7915055",
    "firstNonDiscountedBillingPointUtc": "2021-08-21T05:33:10.7915055",
    "lastDiscountedBillingPointUtc": "2021-07-21T05:33:10.7915055",
    "paymentMethod": "CreditDebitCard",
    "recurringPaymentInfo": {
      "subscriptionReference": 123455,
      "resourceReference": "ResourceReference",
      "configuredSubscriptionPrice": 10,
      "subscribedPrice": 10.21,
      "currency": "GBP",
      "recurringPaymentEnable": false,
      "subscriptionLockedIn": false,
      "nextPaymentDate": "2021-10-21T05:33:10.7915055",
      "previousBillingInfo": {
        "subscriptionPriceId": 94852,
        "totalAmount": 10,
        "totalTaxAmount": 8.33,
        "totalNetAmount": 1.667,
        "billingDate": "2021-09-20T05:33:10.7915055",
        "paymentDate": "2021-09-20T05:33:10.7915055",
        "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"
      }
    },
    "trialInfo": {
      "paid": true,
      "startDate": "2021-09-21T05:33:10.7915055",
      "endDate": "2021-09-22T05:33:10.7915055",
      "duration": 1,
      "durationUnit": "day"
    }
  },
  "defaultSubscriptionInfo": {
    "customParameters": {
      "Origin": "Facebook"
    },
    "subscriptionId": 40000,
    "subscriptionStatus": "Active",
    "subscriptionTitle": "SubscriptionTitle",
    "subscriptionGroup": "SubscriptionGroup",
    "licenseLevel": 0
  }
}
{
  "accountSubscriptionInfo": {
    "startDate": "2021-09-21T05:33:10.7915055",
    "expiryDate": "2021-10-01T05:33:10.7915055",
    "cancellationDate": "2021-10-01T05:33:10.7915055",
    "firstNonDiscountedBillingPointUtc": "2021-08-21T05:33:10.7915055",
    "lastDiscountedBillingPointUtc": "2021-07-21T05:33:10.7915055",
    "paymentMethod": "CreditDebitCard",
    "recurringPaymentInfo": {
      "subscriptionReference": 123455,
      "resourceReference": "ResourceReference",
      "configuredSubscriptionPrice": 10,
      "subscribedPrice": 10.21,
      "currency": "GBP",
      "recurringPaymentEnable": false,
      "subscriptionLockedIn": false,
      "nextPaymentDate": "2021-10-21T05:33:10.7915055",
      "previousBillingInfo": {
        "subscriptionPriceId": 94852,
        "totalAmount": 10,
        "totalTaxAmount": 8.33,
        "totalNetAmount": 1.667,
        "billingDate": "2021-09-20T05:33:10.7915055",
        "paymentDate": "2021-09-20T05:33:10.7915055",
        "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"
      }
    },
    "trialInfo": {
      "paid": true,
      "startDate": "2021-09-21T05:33:10.7915055",
      "endDate": "2021-09-22T05:33:10.7915055",
      "duration": 1,
      "durationUnit": "day"
    }
  },
  "defaultSubscriptionInfo": {
    "customParameters": {
      "Origin": "Facebook"
    },
    "subscriptionId": 40000,
    "subscriptionStatus": "Active",
    "subscriptionTitle": "SubscriptionTitle",
    "subscriptionGroup": "SubscriptionGroup",
    "licenseLevel": 0
  }
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Update the renewal status of a subscription
Add a voucher to a subscription