定期課金: List

このリクエストでは、アプリトークン・シークレット・店舗IDを指定することで、店舗で作成された定期課金の一覧を取得することができます。Query Parametersで絞り込みを行うことも可能です。
作成した定期課金での課金一覧はこちら、支払い予定含む課金の状況を確認したい場合はこちらをご利用下さい。

Request

GET https://api.univapay.com/stores/{storeId}/subscriptions

Parameters:

Parameters
searchstring
メタデータの内容のIDもしくは値を検索します
statusstring
定期課金のステータスで絞り込み。unverified, unconfirmed, canceled, unpaid, suspended, current, completed のいずれか
modestring
実行モードで絞り込み。liveまたはtest

Headers:

Authorization: Bearer {secret}.{jwt}

Body:

curl --request GET \
--url https://api.univapay.com/stores/5820d348-15d1-11e7-8e4b-27dd220b033f \
--header 'Authorization: Bearer {secret}.{jwt}'

Response

Code: 200

Headers:

Content-Type: application/json

Body:

{
  "items": [
    {
      "id": "3a1b484a-18c6-11e7-9914-4bf2088a90c6",
      "merchant_id": "371f512c-18c6-11e7-b12b-53d631f886c5",
      "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
      "amount": 26101,
      "currency": "JPY",
      "amount_formatted": 26101,
      "period": "annually",
      "status": "cancelled",
      "metadata": {},
      "mode": "test",
      "created_on": "2018-07-15T02:55:00.07367Z"
    },
    {
      "id": "3a1b8bac-18c6-11e7-b12b-7334ac0032c1",
      "merchant_id": "371f512c-18c6-11e7-b12b-53d631f886c5",
      "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
      "amount": 25499,
      "currency": "JPY",
      "amount_formatted": 25499,
      "period": "annually",
      "status": "cancelled",
      "metadata": {},
      "mode": "test",
      "created_on": "2018-07-13T02:49:00.07367Z"
    },
    {
      "id": "3a1d2d5e-18c6-11e7-a49f-cb748a690623",
      "merchant_id": "371f512c-18c6-11e7-b12b-53d631f886c5",
      "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
      "amount": 49634,
      "currency": "JPY",
      "amount_formatted": 49634,
      "period": "weekly",
      "status": "unverified",
      "metadata": {},
      "mode": "test",
      "created_on": "2018-07-13T04:34:00.07367Z"
    },
    ...
    {
      "id": "aaadee6a-18e3-11e7-a461-e3b078a7dc52",
      "merchant_id": "371f512c-18c6-11e7-b12b-53d631f886c5",
      "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
      "amount": 1250,
      "currency": "USD",
      "amount_formatted": 12.5,
      "period": "daily",
      "status": "unverified",
      "metadata": {
        "ServiceId": 78435694
      },
      "mode": "test",
      "created_on": "2018-08-13T02:08:00.07367Z"
    }
  ],
  "has_more": false
}