Remove addon from subscription

Use when removing an add-on from a subscription (e.g. downgrade or opt-out).

DELETE /subscriptions/addon

Remove addon from subscription

cURL

curl --request DELETE \
  --url https://us.api.flexprice.io/v1/subscriptions/addon \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "addon_association_id": "<string>",
  "effective_date": "2023-11-07T05:31:56Z",
  "reason": "<string>"
}
'

import requests

url = "https://us.api.flexprice.io/v1/subscriptions/addon"

payload = {
    "addon_association_id": "<string>",
    "effective_date": "2023-11-07T05:31:56Z",
    "reason": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    addon_association_id: '<string>',
    effective_date: '2023-11-07T05:31:56Z',
    reason: '<string>'
  })
};

fetch('https://us.api.flexprice.io/v1/subscriptions/addon', 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://us.api.flexprice.io/v1/subscriptions/addon",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'addon_association_id' => '<string>',
    'effective_date' => '2023-11-07T05:31:56Z',
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://us.api.flexprice.io/v1/subscriptions/addon"

	payload := strings.NewReader("{\n  \"addon_association_id\": \"<string>\",\n  \"effective_date\": \"2023-11-07T05:31:56Z\",\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("DELETE", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://us.api.flexprice.io/v1/subscriptions/addon")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"addon_association_id\": \"<string>\",\n  \"effective_date\": \"2023-11-07T05:31:56Z\",\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/subscriptions/addon")

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

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"addon_association_id\": \"<string>\",\n  \"effective_date\": \"2023-11-07T05:31:56Z\",\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

{
  "http_status_code": 123,
  "message": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Remove Addon Request

addon_association_id · string · required

effective_date · string<date-time>

EffectiveDate is the date the cancellation takes effect. When nil the addon is cancelled at the end of the current period. When provided it must fall within [CurrentPeriodStart, CurrentPeriodEnd]; mid-period values combined with create_prorations will issue a wallet credit for unused time.

proration_behavior · enum<string>

Available options: create_prorations, none

reason · string

Response

200

application/json

OK

message · string