Skip to navigation
Transaction APIWallet Grants

Get a wallet grant

Requires the WALLET_GRANT.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
customer_idstring or nullOptional
The ID of the customer.
billing_entity_idstring or nullOptional
The ID of the billing entity granting the wallet grant.
wallet_idstring or nullOptional
The ID of the wallet.
typeenumOptional
The type of wallet grant.
Allowed values:
sourceenum or nullOptionalRead-only
What the grant quantity was derived from at issuance. Not set for manually created grants.
Allowed values:
seatobject or nullOptional

The seat this grant is restricted to. Only set when the source is PER_SEAT.

over_grantedobject or nullOptional

The part of this grant beyond what the period's paid-for seats account for, judged at issuance.

descriptionstring or nullOptionalformat: "^.*$"0-256 characters
The description of the wallet grant.
grant_amountobjectOptional
The value of the grant in case of an amount wallet type.
grant_creditsobjectOptional
The value of the grant in case of a credits wallet type.
paid_amountobjectOptional
start_atdatetime or nullOptional
expire_atdatetime or nullOptional
created_atstring or nullOptionalRead-only
reverted_atstring or nullOptionalRead-only

When the grant was reverted: after a schedule or subscription change left its period unbilled, or when its invoice was voided. A reverted grant can no longer be spent. Not set on an active grant, nor on a grant reverted before this field existed.

revert_reasonenum or nullOptionalRead-only

Why the grant was reverted: INVOICE_VOIDED when its invoice was voided; WALLET_GRANT_REVERTED when the subscription was checked again after another of its grants was reverted and this grant's period was no longer billed; otherwise the schedule or subscription change that left its period unbilled. Not set on an active grant, nor on a grant reverted before this field existed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error