Update Subscription Attributes

2min

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
Bearer
PATH PARAMETERS
accountReference
string
*
subscriptionReference
string
*
HEADER PARAMETERS
X-TokenId
string
The eSuite Token Id
X-SessionId
string
The eSuite Session Id
X-Version
string
*
The eSuite Version
Origin
string
The eSuite Origin
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
Account Subscription result
subscriptions
FictiveGlobal.Api.Rest.Dtos.v2.AccountSubscription[]
Subscriptions
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.
﻿
﻿

Updated 22 Sep 2023

Did this page help you?

Update the renewal status of a subscription

Add a voucher to a subscription

Docs powered by

Archbee