Update a feature credits entry

PATCH

accounts

{account_id}

features

{feature_id}

entries

{entry_id}

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
}'

{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "status": "ACTIVE",
  "source": "ENTITLEMENT",
  "effectiveFrom": "2020-01-01T00:00:00Z",
  "effectiveUntil": "2025-01-01T00:00:00Z",
  "granted": 15,
  "balance": 10,
  "used": 5
}

Initial:

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

Action: Update granted units to 120 units

POST /accounts/acc.fdjsl.313/features/feat.fdjsl.313/entries/<entry_id>

{
  "grantedUnits": 120
}

Output

Adjustment units = new granted units - previous granted units $(120 - 100 = 20)$

New balance = current balance + adjustment units $(20 + 20 = 40)$

Initial:

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

Action: Update granted units to 70 units

POST /accounts/acc.fdjsl.313/features/feat.fdjsl.313/entries/<entry_id>

{
  "granted": 70
}

Output

Adjustment 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

headerrequired

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

feature_id

string

required

feature_id corresponding to a feature

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

Body

application/json

effectiveUntil

string

Expiry date-time for a feature credits entry

granted

number

Granted units for a feature credits entry

Response

200 - application/json

string

required

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

required

effectiveUntil

string

required

granted

number

balance

number

used

number

required

List feature credits entries of a feature for an account Void a feature credits entry of a feature for an account

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
}'

{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "status": "ACTIVE",
  "source": "ENTITLEMENT",
  "effectiveFrom": "2020-01-01T00:00:00Z",
  "effectiveUntil": "2025-01-01T00:00:00Z",
  "granted": 15,
  "balance": 10,
  "used": 5
}

Introduction

APIs

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

Authorizations

Path Parameters

Body

Response