Pause a recurring payment.

POST

/v1/recurring-payments/{reference}/pause

const url = 'https://api.ridleypay.com/v1/recurring-payments/WOO-SUB-456/pause';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.ridleypay.com/v1/recurring-payments/WOO-SUB-456/pause \
  --header 'Authorization: Bearer <token>'

Temporarily pauses billing. No charges will be made until resumed.

Authorizations

default

Parameters

Path Parameters

reference

required

string

The recurring payment reference.

Example

WOO-SUB-456

Responses

200

Paused

application/json

object

data

object

string

type

string

attributes

object

reference

string

status

string

links

object

self

string

meta

object

message

string

Example

{
  "data": {
    "id": "1",
    "type": "recurring-payments",
    "attributes": {
      "reference": "WOO-SUB-456",
      "status": "paused"
    },
    "links": {
      "self": "https://pay.example.com/api/v1/recurring-payments/WOO-SUB-456"
    }
  },
  "meta": {
    "message": "Recurring payment paused."
  }
}

404

Not found

application/json

object

errors

Array<object>

object

status

string

title

string

detail

string

Example

{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "Recurring payment not found."
    }
  ]
}

422

Cannot pause

application/json

object

errors

Array<object>

object

status

string

title

string

detail

string

Example

{
  "errors": [
    {
      "status": "422",
      "title": "Unprocessable Entity",
      "detail": "Only active or suspended recurring payments can be paused."
    }
  ]
}