Patch subscription

Patch subscription

patch

https://engine-sandbox.nowacash.comhttps://engine.nowacash.com

/api/v1/subscriptions/{id}

Patch subscription

Authorizations

BearerAuth

AuthorizationstringRequired

The client sends HTTP requests with the Authorization header that contains the word Bearer followed by a space and the Shop Api Key.

Path parameters

idstringRequired

Subscription Id

Pattern: /[a-zA-Z0-9]{32}/

Body

application/json

statestring · enumOptional

New subscription state

Example: CANCELLEDPossible values:

Responses

200

Subscription Response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch

/api/v1/subscriptions/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/subscriptions/{id} HTTP/1.1
Host: engine-sandbox.nowacash.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "state": "CANCELLED"
}

{
  "timestamp": "2020-10-07T13:36:32.595+00:00",
  "status": 200,
  "result": {
    "id": "text",
    "customerReferenceId": "text",
    "description": "Subscription to service",
    "amount": 1,
    "currency": "text",
    "createTime": "2030-12-25T10:11:12",
    "startTime": "2030-12-25T10:11:12",
    "frequency": 2,
    "frequencyUnit": "DAY",
    "requestedNumberOfCycles": 12,
    "state": "ACTIVE",
    "recurringToken": "text",
    "retryStrategy": {
      "frequency": 2,
      "frequencyUnit": "DAY",
      "numberOfCycles": 12,
      "amountAdjustments": [
        1
      ]
    },
    "cycles": [
      {
        "sequence": 1,
        "type": "REGULAR",
        "startTime": "2030-12-25T10:11:12",
        "paymentId": "text",
        "paymentState": "PENDING",
        "amount": 1
      }
    ]
  }
}