Set the default version

curl --request PATCH \
  --url https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default": true
}
'

import requests

url = "https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}"

payload = { "default": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({default: true})
};

fetch('https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}', 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/plans/{id}/versions/{versionNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'default' => true
  ]),
  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/plans/{id}/versions/{versionNumber}"

	payload := strings.NewReader("{\n  \"default\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default\": true\n}"

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

{
  "id": "<string>",
  "object": "plan_version",
  "versionNumber": 2,
  "status": "published",
  "isDefault": true,
  "subscriptionCount": 1,
  "updatedAt": "2023-11-07T05:31:56Z",
  "prices": [
    {
      "id": "<string>",
      "object": "price",
      "merchantId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "invoiceDisplayName": "<string>",
      "model": "standard",
      "paymentTerm": "in_arrears",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "quantity": 1,
      "priceDeleted": true,
      "billableMetricId": "<string>",
      "feeId": "<string>",
      "billingCadence": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "unitAmount": "<string>",
      "features": [
        {
          "id": "<string>",
          "featureId": "<string>",
          "entitlementTemplate": {},
          "feature": {
            "key": "<string>",
            "name": "<string>",
            "type": "metered"
          }
        }
      ],
      "grantDiscountEnabled": false,
      "isObligation": false
    }
  ],
  "publishedAt": "2023-11-07T05:31:56Z",
  "basedOnVersionId": "<string>"
}

{
  "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"
}

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

PATCH

plans

{id}

versions

{versionNumber}

Set the default version

curl --request PATCH \
  --url https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "default": true
}
'

import requests

url = "https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}"

payload = { "default": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({default: true})
};

fetch('https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}', 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/plans/{id}/versions/{versionNumber}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'default' => true
  ]),
  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/plans/{id}/versions/{versionNumber}"

	payload := strings.NewReader("{\n  \"default\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"default\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygentic.io/v0/plans/{id}/versions/{versionNumber}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"default\": true\n}"

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

{
  "id": "<string>",
  "object": "plan_version",
  "versionNumber": 2,
  "status": "published",
  "isDefault": true,
  "subscriptionCount": 1,
  "updatedAt": "2023-11-07T05:31:56Z",
  "prices": [
    {
      "id": "<string>",
      "object": "price",
      "merchantId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "invoiceDisplayName": "<string>",
      "model": "standard",
      "paymentTerm": "in_arrears",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "quantity": 1,
      "priceDeleted": true,
      "billableMetricId": "<string>",
      "feeId": "<string>",
      "billingCadence": "<string>",
      "currency": "<string>",
      "description": "<string>",
      "unitAmount": "<string>",
      "features": [
        {
          "id": "<string>",
          "featureId": "<string>",
          "entitlementTemplate": {},
          "feature": {
            "key": "<string>",
            "name": "<string>",
            "type": "metered"
          }
        }
      ],
      "grantDiscountEnabled": false,
      "isObligation": false
    }
  ],
  "publishedAt": "2023-11-07T05:31:56Z",
  "basedOnVersionId": "<string>"
}

{
  "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"
}

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

Authorizations

Authorization

string

header

required

API key authentication

Path Parameters

string

required

Unique identifier for a plan

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

versionNumber

integer

required

The version number within the plan (1-based).

Required range: x >= 1

Body

application/json

Sets this version as the plan's default.

default

boolean

Set to true to point the plan's default at this version. Idempotent on the already-default version.

Response

The transitioned plan version

A single plan version, including its price slots. Extends the list summary with the version's prices.

string

required

Unique identifier for a plan version

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

object

enum<string>

required

Available options:

plan_version

versionNumber

integer

required

Monotonic version number within the plan, starting at 1.

Required range: x >= 1

status

enum<string>

required

Lifecycle status of the version.

Available options:

published,

archived

isDefault

boolean

required

Whether this version is the plan's current default (live) version.

subscriptionCount

integer

required

Number of committed-status subscriptions pinned to this version at creation time. Not a live-billing cohort.

Required range: x >= 0

updatedAt

string<date-time>

required

When this version was last modified.

prices

object[]

required

The price slots that make up this version.

Show child attributes

publishedAt

string<date-time>

When this version was published.

basedOnVersionId

string

The version this one follows on from — the version that was live when this one was created, and whose prices it was built from. Absent for versions created before this field existed.

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

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

Set the default version

Authorizations

Path Parameters

Body

Response