クーポンには、金額ベースまたは％ベースの割引についての情報が含まれており、プロモーションコードによりお客様の注文に適用できます。
属性
- id文字列
- クーポンオブジェクトの一意の識別子です。
- object文字列 (値は coupon)
- オブジェクトの種類を表す文字列です。同じ種類のオブジェクトの場合は同じ値を共有します。
- activeブール値
- クーポンが有効で使用可能な場合は
trueの値、そうでない場合はfalseの値です。 - createdAtタイムスタンプ
- オブジェクトが作成された時間です。Unix エポックからのミリ秒数で表されます。
- currency文字列
- discountType が
amountの場合、小文字3文字の ISO 通貨コードです。サポートされている通貨である必要があります。 - discountAmount正の数値
- discountType が
amountの場合、当該クーポンオブジェクトの割引額です。 - discountPercentage数値
- discountType が
percentageの場合、当該のクーポンオブジェクトの割引率です。 - discountType列挙
- 当該クーポンの割引の種類です。
列挙値の例
-
amount一定の割引額のクーポンです。
-
percentage金額に対する割引率のクーポンです。
-
- expiresAtタイムスタンプまたは空値
- クーポンが失効する時間です。Unix エポックからのミリ秒数で表されます。
- maxRedemptionCount正の整数または空値
- 有効期間内に当該クーポンを利用できるお客様全体での最大の合計回数です。
- metadataオブジェクト
- キーと値のペアで、クーポンオブジェクトにアタッチできます。
- name文字列
- クーポンの名前です。お客様に表示されます。
- redemptionCount正の整数
- 当該クーポンが注文に適用された回数です。
- sponsoredブール値
- クーポンが Smartpay の出資によるものである場合は
trueの値、そうでない場合はfalseの値です。 - testブール値
- オブジェクトがライブモードで存在する場合は
falseの値を、オブジェクトがテストモードで存在する場合はtrueの値を持つフラグです。 - updatedAtタイムスタンプ
- オブジェクトが最後に更新された時間です。Unix エポックからのミリ秒数で表されます。