Deposits credits onto the caller's OWN entitlement balance, authorized by their license-session token. Only honored for self-service entitlements (issued from a signup offer) whose offer lets consumers grant themselves credits — for tenant-provisioned customers, and wherever the vendor sells credits, deposits remain an admin/machine operation.
const url = 'https://example.com/api/v1/provision/consumer/me/credits/grant';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"sessionId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","metric":"example","amount":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/provision/consumer/me/credits/grant \ --header 'Content-Type: application/json' \ --data '{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "amount": 1 }'Request Bodyrequired
Section titled “Request Bodyrequired”The caller’s session, the balance-carrying metric, and the amount.
Consumer-side credit grant: deposits onto the CALLER’s own entitlement balance, authorized by their license-session token. Only honored for self-service entitlements (issued from a signup offer) whose offer lets consumers grant themselves credits, which it does not unless the vendor turns that on — the demo/top-up loop, not a general consumer credit-minting surface.
object
The caller’s own session id (must match the license token).
The balance-carrying metric to deposit onto (e.g. the product’s extra-credits metric).
Credits to add: more than zero and at most 100,000 (double GrantSessionCreditsDto.MaximumAmount), and no more than brings the balance to 1,000,000 (double GrantSessionCreditsDto.MaximumBalance). Anything else is refused with a validation error and nothing is deposited.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "amount": 1}Consumer-side credit grant: deposits onto the CALLER’s own entitlement balance, authorized by their license-session token. Only honored for self-service entitlements (issued from a signup offer) whose offer lets consumers grant themselves credits, which it does not unless the vendor turns that on — the demo/top-up loop, not a general consumer credit-minting surface.
object
The caller’s own session id (must match the license token).
The balance-carrying metric to deposit onto (e.g. the product’s extra-credits metric).
Credits to add: more than zero and at most 100,000 (double GrantSessionCreditsDto.MaximumAmount), and no more than brings the balance to 1,000,000 (double GrantSessionCreditsDto.MaximumBalance). Anything else is refused with a validation error and nothing is deposited.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "amount": 1}Consumer-side credit grant: deposits onto the CALLER’s own entitlement balance, authorized by their license-session token. Only honored for self-service entitlements (issued from a signup offer) whose offer lets consumers grant themselves credits, which it does not unless the vendor turns that on — the demo/top-up loop, not a general consumer credit-minting surface.
object
The caller’s own session id (must match the license token).
The balance-carrying metric to deposit onto (e.g. the product’s extra-credits metric).
Credits to add: more than zero and at most 100,000 (double GrantSessionCreditsDto.MaximumAmount), and no more than brings the balance to 1,000,000 (double GrantSessionCreditsDto.MaximumBalance). Anything else is refused with a validation error and nothing is deposited.
Examplegenerated
{ "sessionId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "amount": 1}Responses
Section titled “Responses”OK
Result of a session credit grant: the entitlement and metric affected and the amount deposited, which is the amount requested.
object
Result of a session credit grant: the entitlement and metric affected and the amount deposited, which is the amount requested.
object
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "granted": 1}Result of a session credit grant: the entitlement and metric affected and the amount deposited, which is the amount requested.
object
Examplegenerated
{ "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "granted": 1}Bad Request
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Unauthorized
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Forbidden
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Conflict
object
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}