Move to a higher package (applies immediately)

curl --request POST \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "package_code": "<string>"
}
'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade"

payload = { "package_code": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({package_code: '<string>'})
};

fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'package_code' => '<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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade"

	payload := strings.NewReader("{\n  \"package_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"package_code\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "action": "upgrade",
    "applies": "immediately",
    "effective": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "module_key": "<string>",
    "seats": 123
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

POST

subscription

upgrade

Move to a higher package (applies immediately)

curl --request POST \
  --url https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "package_code": "<string>"
}
'

import requests

url = "https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade"

payload = { "package_code": "<string>" }
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({package_code: '<string>'})
};

fetch('https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade', 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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'package_code' => '<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://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade"

	payload := strings.NewReader("{\n  \"package_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"package_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mwxpyoqrtdfxubdotbmj.supabase.co/functions/v1/public-api/v1/subscription/upgrade")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"package_code\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {
    "action": "upgrade",
    "applies": "immediately",
    "effective": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "module_key": "<string>",
    "seats": 123
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed",
    "details": {
      "fields": {
        "first_name": "First name is required"
      }
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "AUTH_INVALID_KEY",
    "message": "Invalid API key"
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "<string>",
    "details": "<unknown>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timestamp": "2023-11-07T05:31:56Z",
    "rate_limit": {
      "limit": 123,
      "remaining": 123,
      "reset": 123
    }
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Retry after 12 seconds.",
    "details": {
      "limit": 60,
      "remaining": 0,
      "reset": 1718400000000,
      "retry_after": 12
    }
  },
  "meta": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-02-15T10:00:00.000Z"
  }
}

Authorizations

x-api-key

string

header

required

API key from Settings > API Keys or POST /v1/api-keys. Format f9_live_<32 hex chars> (live) or f9_test_<32 hex chars> (sandbox — no real sends, ever). Legacy wcrm_live_ / wcrm_test_ keys still authenticate but are no longer issued. Shown once at creation; only a hash is stored.

Headers

Idempotency-Key

string

Opaque client-generated key that makes a retried POST safe. Resending the same key with the SAME body replays the original response (marked with Idempotent-Replay: true) instead of creating a second record. Resending it with a DIFFERENT body is rejected with 422. Keys are scoped to your company and to the endpoint, and expire after 24 hours.

Required string length: 8 - 255

Pattern: ^[A-Za-z0-9_.:@+\-]+$

Body

application/json

package_code

string

required

billing_cycle

enum<string>

Available options:

monthly,

annual

Response

Upgrade applied

success

enum<boolean>

Available options:

true

data

object

The outcome of a plan/seat/module change. Fields vary by action; the ones below are the stable ones.

Show child attributes

Getting started

Working with data

Workspace administration

Communications & scheduling

Connect an application

Endpoints

Move to a higher package (applies immediately)

Authorizations

Headers

Body

Response