Skip to main content
POST
/
bill
/
{billId}
/
cancelScheduledPayment
Cancel a bill's scheduled payment
curl --request POST \
  --url https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://rest.staging.nickel.com/bill/{billId}/cancelScheduledPayment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "amountDueInCents": 123,
  "totalAmountInCents": 123,
  "vendorId": "<string>",
  "vendorName": "<string>",
  "dueDate": "<string>",
  "reference": "<string>",
  "status": "<string>",
  "documents": [
    "<string>"
  ],
  "scheduledWithdrawalDate": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}
{
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

billId
string
required

ID of the bill whose scheduled payment to cancel

Response

Successful operation

id
string
amountDueInCents
integer<int64> | null
totalAmountInCents
integer<int64> | null
vendorId
string | null
vendorName
string | null
dueDate
string | null
reference
string | null
status
string | null
documents
string[]
scheduledWithdrawalDate
string | null

Day (YYYY-MM-DD, US Eastern) a pending scheduled payment will debit your payment method, or null when the bill has no pending scheduled payment. Note that a bill with a pending scheduled payment already reports status: Paid; if the scheduled payment is cancelled or fails, the bill returns to Open and this field returns to null.