订阅对象

属性

此对象表示可与客户关联的订阅。

id 字符串
订阅的唯一标识符(最多 64 个;最少 36 个)。
Example: 7304911d-5df9-429e-8488-ad41abea1a4c

name 字符串
订阅名称(最多 255 个;最少 3 个)。
例如:sub_001

description 字符串
订阅说明(最多 255 个;最少 3 个)。
例如:Servicio de streaming流媒体服务

account_id 字符串
可使用订阅计划的账户的唯一标识符(MAX 64;MIN 36)。 的唯一标识符(最多 64 个;最少 36 个)。
Example: 2404911d-5df9-429e-8488-ad41abea1a4b

merchant_reference 字符串
订购计划的标识(最多 255; 最小 3)。
示例:001_marzo_23

country 字符串
订阅的国家。
例如 二氧化碳

status 枚举
订阅状态。
可能的值:

  • ACTIVE=该订阅已与关联客户一起创建,并已激活。 激活。
  • PAUSED=订阅已暂停,可以重新激活。
  • COMPLETED=订阅已完成,因为已到达结束日期和时间。
  • CANCELED=取消订阅。

amount 反对

指定订阅金额对象,包括值和货币。

currency 枚举
用于payment 的货币(MAX 3; MIN 3; ISO 4217).
可能的枚举值:查看国家参考信息

value 编号
payment 金额(0.0001 的倍数)。
例如:12100.00

frequency 反对

为订阅付款定义的频率。
如果未设置,类型默认为 MONTH,值默认为 1。

type 枚举
订阅的时间间隔类型(日、周、月)、 周、月)。如果未设置,默认为月。
可能的枚举值: DAY, MONTHYEAR.

value int
订阅的每个时间间隔之间的值。 之间的值。如果未设置,默认情况下始终为 1。
示例:1

billing_cycles 反对

指定 billing_cycles 对象。

total 编号
账单周期总数。
例如 10

current 编号
当前账单周期的值。
例如:2

next_at 时间戳
下次支付订阅费用的日期。
Example: 2023-02-16T20:00:00.786342Z

billing_date 反对

[可选] 指定账单日期对象。与频率对象互斥。

type 编号
订阅的账单日期类型。 时间的计费日期类型。预付、后日、日。如果未设置,将默认设置计划的创建日期。
示例: 计划创建日期

day 编号
如果类型设置为 "日",则为每月的哪一天。 设置为 "日 "时,要向订阅付费的月日。默认情况下总是 1。
例如:2

customer_payer 反对

指定客户付款人对象。

id* 字符串
客户的唯一标识符(最多 255 个;最少 3 个)。
示例:3t04911d-5df9-429e-8488-ad41abea1a2c

payment_method 对象数组

指定payment对象。

type 枚举
付款方式类型。
可能的枚举 值: CARD

token 字符串
由 Yuno SDK 提供的一次性使用支付方式token (最多 64 个;最少 36 个)。
Example: 9104911d-5df9-429e-8488-ad41abea1a4b

vaulted_token 字符串
存储支付方式的保险库token (最大:64;最小:36)。
Example: 6104911d-5df9-429e-8488-ad41abea1a4b

card 反对

指定卡片对象。

verify 布尔
使用金额 = 0 和验证 = true,可以在不授权真实金额的情况下验证用户卡。 验证用户的银行卡,而无需授权实际金额。
可能的值: turefalse.

card_data 反对

指定 card_data 对象。

number 字符串
不含任何分隔符的卡号(最多 19 个; 最小 8)- 仅适用于 PCI 认证的商家。
例如4507990000000010

expiration_month 编号
卡的到期月份 - MM(最大 2; MIN 2)- 仅适用于 PCI 认证的商家。
例如:10

expiration_year 编号
卡的有效年份 - YYYY(最大 4; MIN 4)- 仅适用于 PCI 认证的商家。
例如:2025 年

security_code 编号
卡的安全码(最多 4 个;最少 3 个)- 仅适用于 PCI 认证的商家。 仅适用于通过 PCI 认证的商家。
例如:123

holder_name 字符串
持卡人在卡上的全名(最多 26 个;最少 3 个 最多 26 个;最少 3 个)- 仅适用于 PCI 认证的商家。
示例:JOHN约翰 DOE

trial_period 反对

指定 trial_period 对象。

billing_cycles 编号
免费试用版应适用的计费周期总数。 应适用。
例如 1

amount 反对

试用期的折扣金额。

currency 字符串
试用期使用的货币。(ISO 4217 max 3; min 3)。
示例:COPCOP

value 编号
卡的到期月份 - MM(最大 2; MIN 2)- 仅适用于 PCI 认证的商家。
例如:10

availability 反对

指定可用性对象。订阅可用的日期。如果为空,开始日期 将是创建日期,且没有结束日期。

start_at 时间戳
订阅可使用的开始日期。 可使用的开始日期。
Example: 2024-01-16T00:00:00.786342Z

finish_at 时间戳
订阅可使用的结束日期。 的结束日期。
Example: 2024-05-26T20:00:00.786342Z

retries 反对

指定重试对象。我们是否需要重试 Yuno 中被拒绝的交易,以及必要时的金额。

retry_on_decline bool
第一次拒绝付款后,我们是否应该重试付款。默认为假。
例如真

amount 编号
订阅计划完成后的重试次数。如果未设置或高于 7,则 7 将被定义为默认值。最大:7
例如4

initial_payment_validation bool
标志,用于识别订阅是否应 等待首次付款才能继续。默认为假。 MIN 27)。
示例:假

metadata 反对

指定元数据对象。

key 字符串
此值作为元数据的名称或标识符。请使用描述性术语。(最大值 48;最小值 1)。
示例:sub_ext_id

value 字符串
您希望存储在元数据中的信息。(最大值 512;最小值 1)
示例:AA001AA001

payments 字符串数组

指定付款数组。

id* 字符串
付款的唯一标识符(最多 64 个;最少 36 个)。
示例: 5104911d-5df9-229e-8468-bd41abea1a4s5104911d-5df9-229e-8468-bd41abea1a4s

created_at 时间戳
订阅创建日期和时间 (ISO 8601 MAX 27; MIN 27)。
Example: 2023-12-16T20:46:54.786342Z

updated_at 时间戳
订阅最后更新日期和时间 (ISO 8601 最大 27;MIN 27)。
Example: 2023-12-16T21:00:54.786342Z

additional_data 反对

指定 additional_data 对象。该对象不是强制性的。但是,如果发送此信息 用户的payment 体验将得到提升。

order 反对

指定订单对象。

items 对象数组

指定项目的对象。

id 字符串
项目的唯一标识符(最多 255 个;最少 3 个)。
例如3214

name 字符串
项目名称(最多 255 个;最少 3 个)。
示例:iPhone 12 Pro Max

quantity int
项目数量(最大 999;最小 1)。
示例:1

unit_amount 浮动
项目的单位金额(0.0001 的倍数)。
例如550

category 字符串
项目类别(最多 255 个;最少 3 个)。
可能的值:检查项目类别列表

brand 字符串
物品的品牌(最多 255 个;最少 3 个)。
举例说明:苹果公司

sku_code 字符串
物品的库存单位 (SKU)(最多 255 个;最少 3 个)。
示例:A2342A2342

manufacture_part_number 字符串
物品的生产零件编号(最多 255 个;最少 3 个)。
例如345621234