taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

delete-subscription.rst (706B)

      1 .. ts:op:: deleteSubscription
      2 
      3   Delete all subscription tokens of one token family from the wallet.
      4 
      5   **Request:**
      6 
      7     The request arguments must be a `DeleteSubscriptionRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is an empty object.
     12 
     13   **Side effects:**
     14 
     15     Deletes all subscription tokens of the token family from the wallet
     16     database.  If any token of the family is still in use by a
     17     transaction, nothing is deleted.
     18 
     19   **Expected errors:**
     20 
     21     The caller can handle the following errors inline:
     22     ``WALLET_TOKENS_IN_USE``.
     23 
     24 .. ts:def:: DeleteSubscriptionRequest
     25 
     26   interface DeleteSubscriptionRequest {
     27     // Hash of token family info.
     28     tokenFamilyHash: string;
     29   }