Update Subscription Status

Update the status of the existing subscription.

HTTP Status and Response Status Matrix

HTTP
Status
Response StatusResponse Message
200INACTIVE/ACTIVE/CANCELLINGSuccess
400VALIDATION_ERRORRequest body validation failed.
400REJECTEDThe request subscription is either already cancelled or already expired
400REJECTEDThe request subscription is either cancelled, expired or is already active
400REJECTEDThe request subscription is either cancelled, expired or is already inactive
400ERROR_FROM_PGThis will be populated by PG
404SUBSCRIPTION_NOT_FOUNDRequested subscription not found
500INTERNAL_PROCESSING_ERRORGateway account not found.
502/503ERROR_CONNECTING_PGGateway connectivity unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 45

Unique subscription reference (UTR) number received in Create Subscription API.

string
enum
required
length ≤ 10

Action to update the status of the subscription

Allowed:
Headers
string
string
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json