walletGrants

Create a wallet grant

Requires the WALLET_GRANT.CREATE permission.

post/v{version}/wallet-grants

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/wallet-grants
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
customer_idstring nullable required

The ID of the customer.

billing_entity_idstring nullable required

The ID of the billing entity granting the wallet grant.

wallet_idstring nullable required

The ID of the wallet.

type'DEFAULT' | 'PROMOTION'

The type of wallet grant.

source'FIXED' | 'SEAT_POOL' | 'PER_SEAT'

What the grant quantity was derived from at issuance. Not set for manually created grants.

descriptionstring nullable

The description of the wallet grant.

start_atstring date-time nullable
expire_atstring date-time nullable
created_atstring nullable
reverted_atstring nullable

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_reason'INVOICE_VOIDED' | 'SCHEDULE_DATES_CHANGED' | 'SCHEDULE_DELETED' | 'SUBSCRIPTION_CANCELLED' | 'SUBSCRIPTION_UPGRADED' | 'SUBSCRIPTION_VOIDED' | 'SUBSCRIPTION_CANCEL_UNDONE' | 'WALLET_GRANT_REVERTED'

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.

Response

Created

object_typestring nullable
idstring nullable
customer_idstring nullable

The ID of the customer.

billing_entity_idstring nullable

The ID of the billing entity granting the wallet grant.

wallet_idstring nullable

The ID of the wallet.

type'DEFAULT' | 'PROMOTION'

The type of wallet grant.

source'FIXED' | 'SEAT_POOL' | 'PER_SEAT'

What the grant quantity was derived from at issuance. Not set for manually created grants.

descriptionstring nullable

The description of the wallet grant.

start_atstring date-time nullable
expire_atstring date-time nullable
created_atstring nullable
reverted_atstring nullable

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_reason'INVOICE_VOIDED' | 'SCHEDULE_DATES_CHANGED' | 'SCHEDULE_DELETED' | 'SUBSCRIPTION_CANCELLED' | 'SUBSCRIPTION_UPGRADED' | 'SUBSCRIPTION_VOIDED' | 'SUBSCRIPTION_CANCEL_UNDONE' | 'WALLET_GRANT_REVERTED'

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.

Changes

No recorded changes to this operation across all 1 revision of this API.