taler-docs

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

list-subscriptions.rst (875B)

      1 .. ts:op:: listSubscriptions
      2   :read-only:
      3 
      4   List subscription tokens stored in the wallet.  Listed tokens are
      5   grouped by token family.  Only tokens that are within their validity
      6   period and not currently in use by a transaction are listed.
      7 
      8   **Request:**
      9 
     10     The request arguments must be a `ListSubscriptionsRequest` object,
     11     which has the same fields as `ListDiscountsRequest`.
     12 
     13   **Response:**
     14 
     15     On success, the result is a `ListSubscriptionsResponse` object.
     16 
     17 .. ts:def:: ListSubscriptionsRequest
     18 
     19   type ListSubscriptionsRequest = ListDiscountsRequest;
     20 
     21 .. ts:def:: ListSubscriptionsResponse
     22 
     23   interface ListSubscriptionsResponse {
     24     subscriptions: SubscriptionListDetail[];
     25   }
     26 
     27 .. ts:def:: SubscriptionListDetail
     28 
     29   // Same as DiscountListDetail, but without a token count.
     30   type SubscriptionListDetail = Omit<DiscountListDetail, "tokensAvailable">;