更新计划

put/projects/{project_id}/subscriptions/plans/{plan_id}

更新订阅计划参数。

SecuritybasicAuth

Request

path Parameters

project_id required	integer 项目ID。
plan_id required	integer 计划 ID。

Request Body schema: application/json

object

账单扣费重试详情。

value

required

integer

账单扣费重试次数。

object

账单详情。

required

object

账单周期。

value required	integer 时间单位数。该值取决于类型参数： - 如果`type`为`day`，可以是1-366 - 如果`type`为`month`，可以是1-12 - 如果`type`为`lifetime`，则为0
type required	string 时间单位。可以是`day`、`month`或`lifetime`。 Enum: "day" "month" "lifetime"

amount

number <float>

支付金额。

currency

string

购买币种。参照ISO 4217标准的三字母货币代码。

Array of objects

不同货币下的价格列表。

Array

amount required	number <float> 支付金额。
currency required	string 购买币种。参照ISO 4217标准的三字母货币代码。
setup_fee	number <float> 包含在首次发票中收取的一次性初设费。

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

外部计划标识符。

object

带有宽限期相关数据的对象。

value required	integer 两次收费之间的间隔时间。
type required	string 时间单位，可以是`day`。 Value: "day"

group_id

string

计划关联的组ID。

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 越南语。

refund_period

integer

订阅计划可退款的时间期限（单位为天）。

object

value

string

订阅计划状态。

Enum: "active" "disabled"

tags

Array of strings

计划标签。

object

试用期限详细信息。如未传入此参数，则使用默认值（0天）。

value required	integer 两次收费之间的间隔时间。
type required	string 时间单位，可以是`day`。 Value: "day"

Responses

200

OK.

Request samples

application/json

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

Response samples

application/json

{"billing_retry": {"value": 1
},
"charge": {"amount": 20,
"currency": "USD",
"period": {"type": "month",
"value": 1
},
"prices": [{"amount": 17,
"currency": "EUR",
"setup_fee": 1.5
},
{"amount": 2000,
"currency": "JPY",
"setup_fee": 2.5
}
]
},
"description": {"en": "3x more experience!"
},
"expiration": {"type": "day",
"value": 0
},
"external_id": "exp",
"grace_period": {"type": "day",
"value": 2
},
"group_id": null,
"id": 241082,
"localized_name": "Experience boost",
"name": {"en": "Experience boost"
},
"project_id": 40797,
"refund_period": null,
"status": {"value": "active"
},
"tags": [ ],
"trial": {"type": "day",
"value": 7
},
"type": "all"
}