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: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "effectiveUntil": "2023-02-23T14:25:10Z",
  "granted": 200
}'
{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "source": "PURCHASE",
  "accountId": "acc.fdjsl.313",
  "featureId": "feat.fdjsl.313",
  "granted": 15,
  "balance": 10,
  "overageLimit": 20,
  "usedOverage": 15
}

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:

  1. If source of entry is an entitlement grant rate card in price plan: schedule_id#pricing_cycle_start_date$PRICE_PLAN
  2. If source of entry is an entitlement overage rate card in price plan: schedule_id#pricing_cycle_start_date$OVERAGE
  3. 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
id
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 accountVoid a feature credits entry of a feature for an account