Initiate a subscription purchase

1min
POST
This endpoint will provide the ability to initiate the purchase of a subscription.
In the event the account is paying using a synchronous payment method (such as credit card) the purchase will complete instantly,
if the account selects an synchronous payment (PayPal, P24, etc.)
a redirect URL will be provided in the return to the request
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
addSubscriptionRequest
FictiveGlobal.Api.Rest.Dtos.v3.AddSubscriptionDirect
*
Description
Add subscription direct request object
voucherCode
string
contractReference
string
cartReference
string
paymentMethod
string
cvv
string
renewalDay
integer<int32>
renewalDayOffset
integer<int32>
startDate
string<date-time>
pricing
FictiveGlobal.Api.Rest.Dtos.v4.PricingDirect
entitlements
FictiveGlobal.Api.Rest.Dtos.v1.EntitlementParameter[]
customOrderParameters
object
customSubscriptionParameters
object
enhancedProcessingData
object
groupSubscriptionInfo
FictiveGlobal.Api.Rest.Dtos.v1.GroupSubscriptionInfoSummary
asynchronousInitiationParameters
object
shippingAddressReference
string
invoiceAddressReference
string
sendEReceipt
boolean
sendBackOfficeEmail
boolean
customFulfilmentParameters
object
Responses
200
OK
FictiveGlobal.Api.Rest.Dtos.v4.AddSubscriptionSummary
Description
Add subscription response object
amountCharged
number<double>
currency
string
paymentType
string
subscriptionStatus
string
renewalDay
integer<int32>
renewalDayOffset
integer<int32>
startDate
string<date-time>
renewalDate
string<date-time>
orderReference
string
contractReference
string
subscriptionPriceReference
string
subscriptionReference
string
resourceReference
string
asynchronousProcessingParameters
object
shippingAddressReference
string
invoiceAddressReference
string
sessionToken
string
cartReference
string
400
Request is invalid.
403
Unable to authenticate using the provided session.
404
Not Found.
409
Conflict.
412
Precondition Failed.
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' \
--data '{}'
curl --location --globoff 'https://api.fictive.com/REST/api/accounts/{accountReference}/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{}'
Responses
200
400
403
404
409
412
500
{
  "amountCharged": 10,
  "currency": "GBP",
  "paymentType": "eWallet",
  "subscriptionStatus": "Active",
  "renewalDay": 1,
  "renewalDayOffset": 0,
  "startDate": "2021-09-21T05:33:10.2914978+00:00",
  "renewalDate": "2021-09-21T05:33:10.2914978+00:00",
  "orderReference": "0010KFS4AXAQTC1VE6",
  "contractReference": "0010KFS4WXAQTD1IV1",
  "subscriptionPriceReference": "0010NU1UB9TFEGEZ61",
  "subscriptionReference": "SubscriptionReference",
  "resourceReference": "ResourceReference",
  "asynchronousProcessingParameters": {
    "name1": "value1"
  },
  "shippingAddressReference": "0010D0ZRRUGNBNUKM1",
  "invoiceAddressReference": "0010DDXSRHB9ZU07Z1",
  "cartReference": "CDE456"
}
{
  "amountCharged": 10,
  "currency": "GBP",
  "paymentType": "eWallet",
  "subscriptionStatus": "Active",
  "renewalDay": 1,
  "renewalDayOffset": 0,
  "startDate": "2021-09-21T05:33:10.2914978+00:00",
  "renewalDate": "2021-09-21T05:33:10.2914978+00:00",
  "orderReference": "0010KFS4AXAQTC1VE6",
  "contractReference": "0010KFS4WXAQTD1IV1",
  "subscriptionPriceReference": "0010NU1UB9TFEGEZ61",
  "subscriptionReference": "SubscriptionReference",
  "resourceReference": "ResourceReference",
  "asynchronousProcessingParameters": {
    "name1": "value1"
  },
  "shippingAddressReference": "0010D0ZRRUGNBNUKM1",
  "invoiceAddressReference": "0010DDXSRHB9ZU07Z1",
  "cartReference": "CDE456"
}
﻿
﻿
Updated 22 Sep 2023
Did this page help you?
Retrieve an accounts subscriptions
Complete an asynchronous subscription purchase