Update a feature credits entry

curl --request PATCH \
  --url https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveUntil": "2023-02-23T14:25:10Z",
  "granted": 200
}
'

import requests

url = "https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}"

payload = {
    "effectiveUntil": "2023-02-23T14:25:10Z",
    "granted": 200
}
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({effectiveUntil: '2023-02-23T14:25:10Z', granted: 200})
};

fetch('https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}', 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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}",
  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([
    'effectiveUntil' => '2023-02-23T14:25:10Z',
    'granted' => 200
  ]),
  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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}"

	payload := strings.NewReader("{\n  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}")

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  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\n}"

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

{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "source": "PURCHASE",
  "accountId": "acc.fdjsl.313",
  "featureId": "feat.fdjsl.313",
  "granted": 15,
  "balance": 10,
  "overageLimit": 20,
  "usedOverage": 15
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<Reason message>"
}

PATCH

accounts

{account_id}

features

{feature_id}

entries

{entry_id}

Update a feature credits entry

curl --request PATCH \
  --url https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "effectiveUntil": "2023-02-23T14:25:10Z",
  "granted": 200
}
'

import requests

url = "https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}"

payload = {
    "effectiveUntil": "2023-02-23T14:25:10Z",
    "granted": 200
}
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({effectiveUntil: '2023-02-23T14:25:10Z', granted: 200})
};

fetch('https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}', 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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}",
  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([
    'effectiveUntil' => '2023-02-23T14:25:10Z',
    'granted' => 200
  ]),
  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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}"

	payload := strings.NewReader("{\n  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\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.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.togai.com/accounts/{account_id}/features/{feature_id}/entries/{entry_id}")

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  \"effectiveUntil\": \"2023-02-23T14:25:10Z\",\n  \"granted\": 200\n}"

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

{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "source": "PURCHASE",
  "accountId": "acc.fdjsl.313",
  "featureId": "feat.fdjsl.313",
  "granted": 15,
  "balance": 10,
  "overageLimit": 20,
  "usedOverage": 15
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<Reason message>"
}

Example: Increase grantedUnits

Initial:

{
  "id": "<entry_id>",
  "source": PURCHASE",
  "accountId": "acc.fdjsl.313",
  "featureId": "feat.fdjsl.313",
  "granted": 100,
  "balance": 20
}

Action: Update granted units to 120 unitsPOST /accounts/acc.fdjsl.313/features/feat.fdjsl.313/entries/<entry_id>

{
  "grantedUnits": 120
}

OutputAdjustment units = new granted units - previous granted units

(120 - 100 = 20)

New balance = current balance + adjustment units

(20 + 20 = 40)

Example: Reduce grantedUnits

Initial:

{
  "id": "<entry_id>",
  "source": PURCHASE",
  "accountId": "acc.fdjsl.313",
  "featureId": "feat.fdjsl.313",
  "granted": 100,
  "balance": 20
}

Action: Update granted units to 70 unitsPOST /accounts/acc.fdjsl.313/features/feat.fdjsl.313/entries/<entry_id>

{
  "granted": 70
}

OutputAdjustment units = new granted units - previous granted units

(70 - 100 = -30)

New balance = current balance + adjustment units

(20 + (-30) = -10)

-> 400 Bad Request

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id

string

required

account_id corresponding to an account

Maximum string length: 50

Example:

"ACC00001"

feature_id

string

required

feature_id corresponding to a feature

Maximum string length: 50

Example:

"feat.fdjskl.sdkjl"

entry_id

string

required

entryId corresponding to a particular entitlement/overage grant entry

Formats:

If source of entry is an entitlement grant rate card in price plan: schedule_id#pricing_cycle_start_date$PRICE_PLAN
If source of entry is an entitlement overage rate card in price plan: schedule_id#pricing_cycle_start_date$OVERAGE
If source of entry is a purchase: purchase_id#int_index$PURCHASE

Maximum string length: 50

Example:

"purchase.21HbazIT3JQ.D90jC#1$PURCHASE"

Body

application/json

effectiveUntil

string<date-time>

Expiry date-time for a feature credits entry

granted

number

Granted units for a feature credits entry

Response

Success response

Get feature credits response

string

required

Maximum string length: 50

Example:

"purchase.20rvWRxQcQK.0ZwPG$1"

source

enum<string>

required

Source of the feature credit

Available options:

ENTITLEMENT,

PRICE_PLAN,

OVERAGE,

REFUND

status

enum<string>

required

Status of the feature credit entry

Available options:

ACTIVE,

EXPIRED,

VOIDED

effectiveFrom

string<date-time>

required

Example:

"2021-03-04T14:25:10Z"

effectiveUntil

string<date-time>

required

Example:

"2021-05-20T01:00:10Z"

used

number

required

Example:

10

granted

number

Example:

15

balance

number

Example:

10

Introduction

APIs

Update a feature credits entry

This API let’s you to update the following attributes: `effectiveUntil` and `granted`

Authorizations

Path Parameters

Body

Response