Edit
Updated 2,665 Days AgoPublic
Actions

payment_subscriptions.edit

Description

Edit user's subscription. User will remain premium until canceled or max rebill number reached, rebill amount(s) will be changed to new value(s), all other parameters will retain its values.

NOTE: Edit is allowed only once for any user.

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

if system_id == 'a21'
staging: https://cs-a21.dvipdev.com/
production: https://cs-a21.dvipapp.com/
query: /api.json?cmd=payment_subscriptions.edit&sub_id=//value1//&offer=//value2//&next_offer=//value3//

Input Parameters

Name	Type	Required	Description	Note
sub_id	string	Yes	Subscription ID	Retrieved by payment_subscriptions.search
offer	float	Yes	Amount to be used for all rebills (except for next)	Equivalent to rebill_amount in subscription.change
next_offer	float	Yes	Amount to be used for next rebill only	Equivalent to next_rebill_amount in subscription.change

Return

Name	Type	Description	Note
success	bool	Was editing successfull?

Usage Example

example query:

/api.json?cmd=payment_subscriptions.edit&sub_id=211288

example of canceled successfully response:

{
  "meta": {
    "messages": [
      {
        "code": "edit_success",
        "params": null,
        "sticky": false,
        "text": "edit_success"
      }
    ],
    "status": "OK"
  },
  "result": {
    "success": true,
    "id": 0,
    "data": [
      
    ],
    "item": [
      
    ]
  }
}

example of failure response:

{
  "meta": {
    "errors": [
      {
        "code": "downselled",
        "params": null,
        "sticky": false,
        "text": "Already used downsell"
      }
    ],
    "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