Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

Available from CRM.COM R14.0.0


Tip

Deprecated from CRM.COM R17R18.0.0


Excerpt

This method enforces the consumption of wallet funds by prepaid pre-rated services. The method can only be used for consuming wallet funds for prepaid pre-rated services.

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier
(mandatory)

Wallet identifier

The identifier of the wallet whose funds will be consumed. The allowed wallets identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

subscription_identifier

(mandatory based on conditions)

Subscription identifier

The identifier of the subscription whose services will consume the wallet's funds. Only prepaid subscriptions with at least one pre-rated service will be allowed. Mandatory if the account owner has multiple prepaid subscriptions that meed these conditions, otherwise if only one exists, then the wallet funds will be consumed by this single subscription. The allowed subscription identifier fields are the following:

Include Page
V4:subscription_identifier
V4:subscription_identifier

wallet_consumption_up_to_date

(optional)

DateDefines the date up to which the prepaid services will be rated, i.e. the date up to which all of the prepaid services of the subscription will consume the available wallet balance.

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...