List subscription periods

定期課金の周期情報をリストで取得します。

Authorization

AuthorizationBearer <token>

API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。

In: header

Path Parameters

subscriptionId*string

Subscription ID

Query Parameters

limit?integer

最大件数

Default20

Range0 <= value <= 100

offset?integer

検索開始位置

Default0

Response Body

`application/json;charset=utf-8`

curl -X GET "https://api.elepay.io/subscriptions/string/periods"

{
  "total": 0,
  "periods": [
    {
      "id": "string",
      "object": "subscription_period",
      "startTime": 0,
      "endTime": 0,
      "charge": {
        "id": "string",
        "appId": "string",
        "object": "charge",
        "liveMode": true,
        "amount": 0,
        "authorizeAmount": 0,
        "currency": "JPY",
        "authorize": true,
        "paymentMethod": "alipay",
        "resource": "web",
        "orderNo": "string",
        "description": "string",
        "location": {
          "id": "string",
          "name": {
            "kanji": "string",
            "kana": "string",
            "romaji": "string"
          },
          "tel": "string",
          "zip": "string",
          "address": {
            "kanji": {
              "pref": "string",
              "city": "string",
              "town": "string",
              "address1": "string",
              "address2": "string"
            },
            "kana": {
              "pref": "string",
              "city": "string",
              "town": "string",
              "address1": "string",
              "address2": "string"
            },
            "romaji": {
              "pref": "string",
              "city": "string",
              "town": "string",
              "address1": "string",
              "address2": "string"
            }
          },
          "latitude": 0.1,
          "longitude": 0.1,
          "note": "string",
          "status": "active"
        },
        "extra": {
          "property1": "string",
          "property2": "string"
        },
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "cardInfo": {
          "brand": "string",
          "last4": "string",
          "expMonth": 0,
          "expYear": 0,
          "name": "string",
          "issuerCode": "string",
          "issuerName": "string",
          "wallet": "string",
          "walletApp": "string",
          "repaymentType": "string",
          "approvalCode": "string",
          "threeDSecure": true,
          "threeDSecureVersion": "string",
          "threeDSecureDetail": "string",
          "businessType": "string",
          "konbiniScanTime": 0,
          "konbiniType": "string",
          "receivedAmount": 0,
          "receivedTime": 0,
          "bankUserCode": "string",
          "bankUserName": "string",
          "bankName": "string",
          "bankBranchName": "string",
          "bankAccountNo": "string",
          "billingNo": "string"
        },
        "voucherNo": "string",
        "clientIp": "string",
        "paid": true,
        "refunded": true,
        "disputed": true,
        "refunds": {
          "amount": 0,
          "totalCount": 0,
          "data": [
            {
              "id": "string",
              "object": "refund",
              "chargeId": "string",
              "liveMode": true,
              "amount": 0,
              "currency": "str",
              "metadata": {
                "property1": "string",
                "property2": "string"
              },
              "reason": "string",
              "status": "pending",
              "refundedTime": 0,
              "createTime": 0
            }
          ]
        },
        "status": "pending",
        "codeContent": "string",
        "credential": "string",
        "paidTime": 0,
        "refundTime": 0,
        "expiryTime": 0,
        "settleTime": 0,
        "createTime": 0
      }
    }
  ]
}