Cancel
Updated 2,667 Days AgoPublic
Actions

payment_subscriptions.cancel

Description

Cancel user's subscription. User will remain premium until subscription expire, after that it will be demoted to free access.

IMPORTANT: Cancel must be performed against appropriate system's url(system_id, retrieved by payment_subscriptions.search)

if system_id == m21
staging: https://cs-m21.dvipdev.com/
production: https://cs-m21.dvipapp.com/

Input Parameters

Name	Type	Required	Description	Note
item_id	string	Yes	Item ID	Retrieved by payment_subscriptions.search

Return

Name	Type	Description	Note
success	bool	Was canceling successfull?

Usage Example

example query:

/api.json?cmd=payment_subscriptions.cancel&item_id=211288

example of canceled successfully response:

{
  "meta": {
    "status": "OK"
  },
  "result": {
    "success": true,
    "id": 0,
    "data": [
      
    ],
    "item": [
      
    ]
  }
}

example of failure response:

{
  "meta": {
    "errors": [
      {
        "code": "error_not_allowed",
        "params": null,
        "sticky": false,
        "text": "Not allowed"
      }
    ],
    "status": "ERROR"
  },
  "result": {
    "success": false,
    "id": 0,
    "data": [
      
    ],
    "item": [
      
    ]
  }
}

Referenced Files

None

Subscribers

None

Last Author: boris
Last Edited: Jan 6 2017, 08:35

Event Timeline

boris created this document.Jan 6 2017, 08:35

boris edited the content of this document. (Show Details)

boris shifted this object from the Restricted Space space to the S6 Everyone space.Aug 8 2018, 08:12