Get a wallet grant | Solvimon

{
  "object_type": "string",
  "id": "string",
  "customer_id": "string",
  "billing_entity_id": "string",
  "wallet_id": "string",
  "type": "DEFAULT",
  "source": "FIXED",
  "seat": {
    "customer_id": "string",
    "product_item_id": "string"
  },
  "over_granted": {
    "credits": {
      "quantity": "string",
      "credit_type_id": "string",
      "credit_type": {
        "object_type": "string",
        "id": "string",
        "reference": "string",
        "status": "DRAFT",
        "name": "string",
        "description": "string",
        "unit_name": {
          "singular": "string",
          "plural": "string"
        },
        "created_at": "string",
        "updated_at": "string"
      }
    },
    "amount": {
      "quantity": "string",
      "currency": "AED"
    }
  },
  "description": "string",
  "grant_amount": {
    "quantity": "string",
    "currency": "AED"
  },
  "grant_credits": {
    "quantity": "string",
    "credit_type_id": "string",
    "credit_type": {
      "object_type": "string",
      "id": "string",
      "reference": "string",
      "status": "DRAFT",
      "name": "string",
      "description": "string",
      "unit_name": {
        "singular": "string",
        "plural": "string"
      },
      "created_at": "string",
      "updated_at": "string"
    }
  },
  "paid_amount": {
    "quantity": "string",
    "currency": "AED"
  },
  "start_at": "2024-01-15T09:30:00Z",
  "expire_at": "2024-01-15T09:30:00Z",
  "created_at": "string"
}

Requires the WALLET_GRANT.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

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.

Response

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

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors