RArakkokeyword
アカウント

アカウント情報取得

Changed on

アカウント情報取得。 利用者自身の契約プランとクレジットの状況を取得する。

契約プラン・契約日・有効期限日・自動更新設定と、クレジット残高・残高の内訳・オートチャージ設定・次回付与予定・追加クレジットの単価を返す。 機能を実行する前に、残高が足りるか・どのプランで利用しているかを確認できる。

クレジットは消費しない。

get/v1/account/info

Request

Response

取得成功

resultboolean required

API 呼び出しの成否。正常時は true、エラー時は false。

errorsstring[] required

エラーメッセージの配列。正常時は空配列。

Example response

{
  "result": true,
  "data": {
    "rakkoId": 123456,
    "contract": {
      "planKey": "STANDARD",
      "planName": "スタンダードプラン",
      "contractDate": "2026-04-01",
      "dueDate": "2027-03-31",
      "autoUpdate": {
        "enabled": true,
        "months": 12,
        "renewalDate": "2027-03-26"
      }
    },
    "credit": {
      "balance": 1250.5,
      "balanceDetails": [
        {
          "expirationDate": "2026-10-31",
          "grantTypeLabel": "月次付与",
          "remainingAmount": 1000
        }
      ],
      "autoCharge": {
        "thresholdAmount": 500,
        "purchaseAmount": 1000
      },
      "monthlyGrant": {
        "nextGrantDate": "2026-10-01",
        "nextGrantAmount": 1000
      },
      "additionalCreditUnitPrice": 99
    }
  },
  "errors": []
}

Changes

  • 9a79a4653ee1Revision changes
    • info

      removed the LIGHT enum value from the // response property for the response status

  • 084bc7d3e4deRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • info

      response property data/contract/autoUpdate/renewalDate list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property data/credit/monthlyGrant/nextGrantDate list-of-types was narrowed by removing types null from media type application/json of response 200