プランの作成

プランの作成Server-sideAdmin

post/projects/{project_id}/subscriptions/plans

サブスクリプションプランを作成します。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

プロジェクトID。

Request Body schema: application/json

required

object

プラン名。"localization":"plan name"のペアで構成されます。

ar	string アラビア語。
bg	string ブルガリア語。
cn	string 中国語（簡体字）。
cs	string チェコ語。
de	string ドイツ語。
en	string 英語。
es	string スペイン語。
fr	string フランス語。
he	string ヘブライ語。
it	string イタリア語。
ja	string 日本語。
ko	string 韓国語。
pl	string ポーランド語。
pt	string ポルトガル語。
ro	string ルーマニア語。
ru	string ロシア語。
th	string タイ語。
tr	string トルコ語。
tw	string 中国語（繁体字）。
vi	string ベトナム語。

required

object

請求の詳細。

required

object

請求期間。

value required	integer 時間単位の数。値はタイプパラメータに依存し、次のようになります： -`type`は`day`の場合、1から366まで -`type`は`month`の場合、1から12まで、 -`type`は`lifetime`の場合、０です
type required	string 時間の単位。`day`、`month`または`lifetime`にすることができます。 Enum: "day" "month" "lifetime"

amount

number <float>

請求額。

currency

string

購入通貨。ISO 4217に準拠した3文字の通貨コード。

Array of objects

異なる通貨での価格を一覧表示します。

Array

amount required	number <float> 請求額。
currency required	string 購入通貨。ISO 4217に準拠した3文字の通貨コード。
setup_fee	number <float> 最初の請求書の一部として請求される1回のセットアップ費用。

object

請求再試行の詳細。

value

required

integer

請求の再試行回数。

object

プランの説明文。"localization":"plan description"のペアで構成されます。

ar	string アラビア語。
bg	string ブルガリア語。
cn	string 中国語（簡体字）。
cs	string チェコ語。
de	string ドイツ語。
en	string 英語。
es	string スペイン語。
fr	string フランス語。
he	string ヘブライ語。
it	string イタリア語。
ja	string 日本語。
ko	string 韓国語。
pl	string ポーランド語。
pt	string ポルトガル語。
ro	string ルーマニア語。
ru	string ロシア語。
th	string タイ語。
tr	string トルコ語。
tw	string 中国語（繁体字）。
vi	string ベトナム語。

object

サブスクリプションの有効期限の詳細。

value required	integer 有効期間。
type required	string 時間の単位。`day`または`month`にすることができます。 Enum: "day" "month"

external_id

string

プラン外部ID（32文字）。

object

猶予期間の詳細。

value required	integer 時間単位の数。
type required	string 時間の単位。`day`にすることができます。 Value: "day"

group_id

string

プランがリンクされているグループID。

integer

サブスクリプションプラン ID。

project_id

integer

プロジェクトID。

refund_period

integer

ユーザーがサブスクリプションプランの支払いを返金できる期間（日単位）。

object

value

string

サブスクリプションプランのステータス

Enum: "active" "disabled"

tags

Array of strings

プランのタグ。

object

試用期間の詳細。

value required	integer 時間単位の数。
type required	string 時間の単位。`day`にすることができます。 Value: "day"

Responses

201

作成されました。

Request samples

application/json

{"billing_retry": {"value": 1
},
"charge": {"amount": 10,
"currency": "USD",
"period": {"type": "month",
"value": 1
},
"prices": [{"amount": 8,
"currency": "EUR",
"setup_fee": 1.5
},
{"amount": 1000,
"currency": "JPY",
"setup_fee": 2.5
}
]
},
"description": {"en": "2x more experience!"
},
"expiration": {"type": "day",
"value": null
},
"external_id": "exp",
"grace_period": {"type": "day",
"value": 2
},
"name": {"en": "Experience boost"
},
"refund_period": null,
"status": {"value": "active"
},
"trial": {"type": "day",
"value": 7
}
}

Response samples

application/json

{"external_id": "exp",
"plan_id": 241082
}