Cancel subscription

Endpoint for canceling a Subscription.

info

Please be aware that this endpoint requires a Manage Transactions API Key.

PUT /api/v1/groups/{group_id}/revere_pay/{linked_account_id}/recurring/{subscription_id}/cancel

Request Parameters

Name	Description	Type	Required
reason	Optional explanation for the subscription cancellation.	string

Response

Code	Description
200	Success
400	Bad Request / Validation error
500	Internal Error

Example Usage

JavaScript

plans.js

var headers = new Headers();
headers.append('Authorization', 'API_KEY');

var requestOptions = {
	method: 'PUT',
	headers: headers,
	redirect: 'follow',
	body: {
		// request body data
	}
};
const group_id = '';
const linked_account_id = '';
const subscription_id = '';
const url = `https://api.reverepayments.dev/api/v1/groups/${group_id}/revere_pay/${linked_account_id}/recurring/subscription/${subscription_id}/cancel`;
fetch(url, requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.log('error', error));

Python

plans.py

import requests

group_id = ""
linked_account_id = ""
subscription_id = ""
url = "https://api.reverepayments.dev/api/v1/groups/"+group_id+"/revere_pay/"+linked_account_id+"/recurring/subscription/" + subscription_id + "/cancel"

headers = {
  'Authorization': 'API_KEY'
}

response = requests.request("PUT", url, headers=headers, json={
// request body data
})

print(response.text)

Go

plans.go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"net/http"
)

func main() {

	const group_id = ""
	const linked_account_id = ""
	const subscription_id = ""

	url := "https://api.reverepayments.dev/api/v1/groups/" + group_id + "/revere_pay/" + linked_account_id + "/recurring/subscription/" + subscription_id + "/cancel"

	client := &http.Client{}
	body := bytes.NewBuffer(nil)
	_ = json.NewEncoder(body).Encode(map[string]any{
		// body data
	})
	req, _ := http.NewRequest("PUT", url, body)
	req.Header.Add("Authorization", "API_KEY")
	res, _ := client.Do(req)
	defer res.Body.Close()
	bytes, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err.Error())
		return
	}
	fmt.Println(string(bytes))
}

Example Request

{
	"reason": "Duplicate Order"
}

Example Success Response

{
	"id": "eef1b240-6e4d-42f7-93ea-873d165aa696",
	"plan_id": "6f8df983-62a1-4d36-85fd-2e37114fa694",
	"duration": 0,
	"amounts": {
		"amount": 30000,
		"tax_amount": 1000,
		"shipping_amount": 1000
	},
	"billing_cycle": "daily",
	"billing_factor": 7,
	"next_bill_date": "2024-04-18T00:00:00Z",
	"description": "Endless subscription",
	"currency": "USD",
	"processor_id": "<processor_id>",
	"retry_count": 3,
	"metadata": {
		"max_retry_count": 3,
		"form_layout_id": null,
		"form_layout_external_id": null,
		"form_entry_id": null,
		"charge_count": 1,
		"cancel_reason": "Duplicate Order"
	},
	"trial_period_days": 0,
	"payment_method": "card",
	"payment_details": {
		"card": {
			"brand": "Visa",
			"first_six": "411111",
			"last_four": "1111"
		}
	},
	"billing_address": {
		"address": {
			"first_name": "John",
			"last_name": "Doe",
			"city": "New York",
			"line_1": "1st Ave.",
			"line_2": "1217",
			"subdivision": "NY",
			"postal_code": "10065",
			"country": "US",
			"email": "johndoe@example.com"
		}
	},
	"status": "canceled",
	"gateway_customer_id": "<customer_id>"
}