Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-13121230447.8 KB
Entitlements

Update a feature credits entry

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

  • effectiveUntil: must be in future
  • granted: must be greater than the existing usage (previous granted - current balance)
patch/accounts/{account_id}/features/{feature_id}/entries/{entry_id}

Path parameters

account_idstring required
Example:ACC00001

account_id corresponding to an account

feature_idstring required
Example:feat.fdjskl.sdkjl

feature_id corresponding to a feature

entry_idstring required
Example:purchase.21HbazIT3JQ.D90jC#1$PURCHASE

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

Request body

effectiveUntilstring date-time

Expiry date-time for a feature credits entry

grantednumber

Granted units for a feature credits entry

Response

Success response

idstring required
source'ENTITLEMENT' | 'PRICE_PLAN' | 'OVERAGE' | 'REFUND' required

Source of the feature credit

status'ACTIVE' | 'EXPIRED' | 'VOIDED' required

Status of the feature credit entry

effectiveFromstring date-time required
effectiveUntilstring date-time required
grantednumber
balancenumber
usednumber required

Example response

{
  "id": "purchase.20rvWRxQcQK.0ZwPG$1",
  "effectiveFrom": "2021-03-04T14:25:10Z",
  "effectiveUntil": "2021-05-20T01:00:10Z",
  "granted": 15,
  "balance": 10,
  "used": 10
}