Create Adjustment

curl --request POST \
  --url https://api.paygentic.io/v0/subscriptions/{id}/adjustments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "percentageDiscount",
  "percentageDiscount": "0.35",
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "effectiveTo": null,
  "description": "FY26 Growth",
  "idempotencyKey": "adj_fy26_growth_001"
}
'

import requests

url = "https://api.paygentic.io/v0/subscriptions/{id}/adjustments"

payload = {
    "type": "percentageDiscount",
    "percentageDiscount": "0.35",
    "effectiveFrom": "2026-01-01T00:00:00Z",
    "effectiveTo": None,
    "description": "FY26 Growth",
    "idempotencyKey": "adj_fy26_growth_001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'percentageDiscount',
    percentageDiscount: '0.35',
    effectiveFrom: '2026-01-01T00:00:00Z',
    effectiveTo: null,
    description: 'FY26 Growth',
    idempotencyKey: 'adj_fy26_growth_001'
  })
};

fetch('https://api.paygentic.io/v0/subscriptions/{id}/adjustments', 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://api.paygentic.io/v0/subscriptions/{id}/adjustments",
  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([
    'type' => 'percentageDiscount',
    'percentageDiscount' => '0.35',
    'effectiveFrom' => '2026-01-01T00:00:00Z',
    'effectiveTo' => null,
    'description' => 'FY26 Growth',
    'idempotencyKey' => 'adj_fy26_growth_001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.paygentic.io/v0/subscriptions/{id}/adjustments"

	payload := strings.NewReader("{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.paygentic.io/v0/subscriptions/{id}/adjustments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/subscriptions/{id}/adjustments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}"

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

{
  "object": "subscriptionAdjustment",
  "id": "<string>",
  "subscriptionId": "<string>",
  "type": "percentageDiscount",
  "percentageDiscount": "<string>",
  "effectiveFrom": "2023-11-07T05:31:56Z",
  "effectiveTo": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "object": "subscriptionAdjustment",
  "id": "subadj_a1b2c3d4e5f6g7h8",
  "subscriptionId": "sub_z1a2b3c4d5e6f7g8",
  "type": "percentageDiscount",
  "percentageDiscount": "0.35",
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "effectiveTo": null,
  "description": "FY26 Growth",
  "createdAt": "2025-12-20T09:30:00Z"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Subscriptions

Create Adjustment

Attaches a percentage discount to the subscription for a dated window. Every invoice calculated while the window is open carries one discount line for each discounted charge, and tax is assessed on the reduced amount. An invoice that already exists is not changed, including one still in draft — the discount reaches the periods that close after it is created. There is no update operation, and a window cannot be changed after it is created. To change a rate before any invoice has issued under the discount, delete the adjustment and create a replacement. Once an invoice has issued the adjustment is permanent, so set effectiveTo at creation time whenever the deal has a known end date.

POST

subscriptions

{id}

adjustments

Create Adjustment

curl --request POST \
  --url https://api.paygentic.io/v0/subscriptions/{id}/adjustments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "percentageDiscount",
  "percentageDiscount": "0.35",
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "effectiveTo": null,
  "description": "FY26 Growth",
  "idempotencyKey": "adj_fy26_growth_001"
}
'

import requests

url = "https://api.paygentic.io/v0/subscriptions/{id}/adjustments"

payload = {
    "type": "percentageDiscount",
    "percentageDiscount": "0.35",
    "effectiveFrom": "2026-01-01T00:00:00Z",
    "effectiveTo": None,
    "description": "FY26 Growth",
    "idempotencyKey": "adj_fy26_growth_001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'percentageDiscount',
    percentageDiscount: '0.35',
    effectiveFrom: '2026-01-01T00:00:00Z',
    effectiveTo: null,
    description: 'FY26 Growth',
    idempotencyKey: 'adj_fy26_growth_001'
  })
};

fetch('https://api.paygentic.io/v0/subscriptions/{id}/adjustments', 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://api.paygentic.io/v0/subscriptions/{id}/adjustments",
  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([
    'type' => 'percentageDiscount',
    'percentageDiscount' => '0.35',
    'effectiveFrom' => '2026-01-01T00:00:00Z',
    'effectiveTo' => null,
    'description' => 'FY26 Growth',
    'idempotencyKey' => 'adj_fy26_growth_001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.paygentic.io/v0/subscriptions/{id}/adjustments"

	payload := strings.NewReader("{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.paygentic.io/v0/subscriptions/{id}/adjustments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/subscriptions/{id}/adjustments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"percentageDiscount\",\n  \"percentageDiscount\": \"0.35\",\n  \"effectiveFrom\": \"2026-01-01T00:00:00Z\",\n  \"effectiveTo\": null,\n  \"description\": \"FY26 Growth\",\n  \"idempotencyKey\": \"adj_fy26_growth_001\"\n}"

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

{
  "object": "subscriptionAdjustment",
  "id": "<string>",
  "subscriptionId": "<string>",
  "type": "percentageDiscount",
  "percentageDiscount": "<string>",
  "effectiveFrom": "2023-11-07T05:31:56Z",
  "effectiveTo": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

{
  "object": "subscriptionAdjustment",
  "id": "subadj_a1b2c3d4e5f6g7h8",
  "subscriptionId": "sub_z1a2b3c4d5e6f7g8",
  "type": "percentageDiscount",
  "percentageDiscount": "0.35",
  "effectiveFrom": "2026-01-01T00:00:00Z",
  "effectiveTo": null,
  "description": "FY26 Growth",
  "createdAt": "2025-12-20T09:30:00Z"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

{
  "message": "The requested resource was not found",
  "error": "not_found"
}

Authorizations

Authorization

string

header

required

API key authentication

Path Parameters

string

required

The subscription ID

Body

application/json

type

enum<string>

required

The kind of adjustment. percentageDiscount reduces every discountable charge by a rate.

Available options:

percentageDiscount

percentageDiscount

string

required

The discount rate as a decimal fraction between 0 and 1, sent as a string. "0.35" means 35 percent. "1" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.

effectiveFrom

string<date-time>

required

The first instant the discount applies. Inclusive.

effectiveTo

string<date-time> | null

The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.

description

string | null

The deal's own name, shown on each discount line of the invoice.

Maximum string length: 255

idempotencyKey

string

A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.

Required string length: 1 - 255

Example:

"adj_fy26_growth_001"

Response

An adjustment already exists for this idempotency key, and is returned unchanged. Nothing was created.

object

enum<string>

required

Available options:

subscriptionAdjustment

string

required

The adjustment ID

subscriptionId

string

required

Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$

type

enum<string>

required

Available options:

percentageDiscount

percentageDiscount

string

required

The discount rate as a decimal fraction between 0 and 1. "0.35" means 35 percent.

effectiveFrom

string<date-time>

required

The first instant the discount applies. Inclusive.

effectiveTo

string<date-time> | null

required

The instant the discount stops applying. Exclusive. Null means the discount never stops.

description

string | null

required

The deal's own name, shown on each discount line of the invoice.

createdAt

string<date-time>

required

⌘I

Billable Metrics

Customers

Entitlements

Grants

Features

Fees

Plans

Prices

Products

Sources

Subscriptions

Users

Invoices V2

Payments

Payment Sessions

Events

Costs

Revenue

Profitability

Test Clocks

ExternalReferences

Items

Orders

Billing Schedules

Salesforce

MerchantIntegrations

Approvals

Create Adjustment

Authorizations

Path Parameters

Body

Response