[POST] Modify subscription activity

Request Description

POST /v1/subscription/modify_activity

The request allows you to change the activity of a subscription, i.e. cancel it or resume it after cancellation. 
NOTE: The request affects only one subscription of one individual customer.

The subscription activity is a separate attribute.  It is not a subscription status:

• As long as a subscription is active, it is renewable. When active, the subscription can have the following statuses: active or not_paid.

• When deactivating subscriptions, they become cancelled (subscription status changes to cancelled). You can deactivate active subscriptions. This action is available for AR and PRM subscriptions.

• When activating subscriptions, they resume after cancellation (subscription status returns to active or not_paid). You can activate deactivated subscriptions. In addition, these subscriptions must meet the resumption requirements. This action is available for AR subscriptions only.

More details on:

• AR subscription cancellation (same for PMR)

• AR subscription resumption

Connection Data

• Endpoint URL:

  • Production environment: https://api.ecommerce.noventiq.com/v1/subscription/modify_activity

  • Test environment: https://api.ecommerce.noventiq.com.demonqweb.com/v1/subscription/modify_activity

• Request Method: POST

• Format: JSON

• Authorization: token-based

Header Parameters

content-type

string

required

It must be equal to "application/json".

AuthorizationJWT

required

Authorization token.

• Format: Bearer [token]

• Where [token] is substituted by the token value obtained through the authentication API.

Body Parameters

id

required

Subscription identifier
Format: NN_MM, where NN is an identifier of the order that initiates subscriptions (parent order).
You can get it from:

• Webhook (subscription.id)

• Orders API request response

activity

boolean

required

Subscription activity.
Value options:

• true - subscription is activated. If a subscription has the cancelled status and meets the resumption conditions, the subscription gets resumed in case of successful request processing.

• false - subscription is deactivated. If a subscription has the active status, or it is payment pending (not paid), the subscription gets cancelled in case of successful request processing.

suppress_customer_notification

boolean

Suppress subscription cancellation / resumption emails sent to customers.
Value options:

• true - mailing is suppressed. In case of successful request processing subscription cancellation / resumption emails are not sent.

• false - mailing is not suppressed. In case of successful request processing subscription cancellation / resumption emails are sent (if enabled).

It is false by default.

Request Example

Using all the parameters

{
 "id": "111111_22222",
 "activity": false,
 "suppress_customer_notification": true
}

Cancelling a subscription (cancellation emails are sent to customers)

{
 "id": "111111_22222",
 "activity": false
}

Cancelling a subscription while using notification mailing suppression

{
 "id": "111111_22222",
 "activity": false,
 "suppress_customer_notification": true
}

Resuming a subscription (resumption emails are sent to customers)

{
 "id": "111111_22222",
 "activity": true
}

Response Description

In response to the request, you receive the server response code corresponding to the processing result. Depending on the code, the response body may contain additional parameters.

Successful Response

If processing is successful, the following will return in response server response code: HTTP/1.1 200 ОК.

Request processing is considered successful only if corresponding actions are executed with subscriptions:

• The following is transferred in the request: "activity": false - The processing is successful if a subscription gets cancelled as the result of this processing (if the subscription was cancelled earlier, an error returns in response to the request).

• The following is transferred in the request: "activity": true - The processing is successful if a subscription gets resumed as the result of this processing (if the subscription is active at the time of the request transfer, or it is payment pending, an error returns in response to the request).

Error Response

If an error occurs while processing the request, you receive a server response code corresponding to the result of processing.

Depending on the code, the response body may contain additional parameters.

HTTP Server Response Error Code

Additional Error Codes for HTTP 400

Additional Error Codes for HTTP 401

The errors are the same for all the APIs that use token authorization.

Additional Error Codes for HTTP 404

Body Parameters

errors

array [objects]

required

Error list.

errors / [error object] / error

number

required

Error code.

errors / [error object] / message

string

required

Error description.

Example of Error Response

{
 "errors": [{
   "error": 7210,
   "message": "Impossible to cancel the subscription. The subscription was cancelled earlier."
  }
 ]
}

Noventiq Checkout