Change the subscription service.
1 min
POST
https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/move
Path Parameters
- accountReferencestringrequired
- subscriptionReferencestringrequired
Header Parameters
- X-TokenIdstringDescription
- X-SessionIdstringDescription
- X-VersionstringrequiredDescription
- OriginstringDescription
Body Parameters
- requestFictiveGlobal.Api.Rest.Dtos.v1.SubscriptionMove.SubscriptionMoveRequestrequiredDescription
- servicePriceResourceReferencestringDescription
- immediateSwitchbooleanDescription
- settleBalancestring<ServiceCredits | Refund>Description
- taxInfoFictiveGlobal.Api.Rest.Dtos.v2.TaxInfoDescription
- categorystringDescription
- regionFictiveGlobal.Api.Rest.Dtos.v1.TaxRegionInfoDescription
- zeroRatedstringDescription
- countrystringDescription
- statestringDescription
- countystringDescription
- citystringDescription
- zipCodestringDescription
- streetstringDescription
Responses
200
- FictiveGlobal.Api.Rest.Dtos.v1.SubscriptionMove.SubscriptionMoveResponse
- amountChargednumber<double>
- amountRefundednumber<double>
- 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>
- paymentTypestring
- subscriptionStatusstring<CancelledByCustomerSupport | Active | Expired | CancelledByAutoRenew | CancelledByUser | PackPricingItemCancelled | CancelledByPayPalIPN | FailureRetryMode | CancelledByBACS | Pending | CancelledBySEPA | OnHoliday | OnHold>
- renewalDayinteger<int32>
- renewalDayOffsetinteger<int32>
- startDatestring<date-time>Example
- renewalDatestring<date-time>Example
- orderReferencestring
- subscriptionIdinteger<int32>
- subscriptionPriceIdinteger<int32>
- subscriptionReferencestring
- removedOffersinteger[]Example
403
404
405
curl
curl --request POST \
--url https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/move \
--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: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions/{subscriptionReference}/move", 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/{subscriptionReference}/move")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.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/{subscriptionReference}/move"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-version': 'string'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// OK.
{
"amountCharged": "",
"amountRefunded": "",
"currency": "",
"paymentType": "",
"subscriptionStatus": "",
"renewalDay": "",
"renewalDayOffset": "",
"startDate": "2021-09-21T05:33:11.0102626",
"renewalDate": "2021-09-21T05:33:11.0102626",
"orderReference": "",
"subscriptionId": "",
"subscriptionPriceId": "",
"subscriptionReference": "",
"removedOffers": [
0
]
}403
// The account has an existing subscription move.
404
// Subscription cannot be found for the Account provided.
405
// Invalid Subscription Status.
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.