クーポンを作成する


クーポンの作成は、ダッシュボードのクーポンの管理ページから簡単に行えます。急いでクーポンを作成する必要がある場合は、API からもクーポンの作成が可能です。

クーポンには、amount または percentagediscountType があります。amount に設定した場合、その金額が注文の小計から差し引かれます。たとえば、小計が ¥ 5,000 の注文の場合、¥10,000 の discoutAmountamount クーポンが適用されると、最終的な合計金額は ¥0 になります。小計が ¥20,000 の注文の場合は、¥10,000 の discoutAmountamount クーポンが適用されると、最終的な合計金額は ¥10,000 になります。

エラー

返される可能性があるエラーレスポンスについては、エラー をご覧ください。

Body Params

Create Coupon

string

Three-letter ISO currency code, in uppercase. Must be a supported currency.

number
≥ 0

required if discountType is amount. The amount of this coupon object.

number
0 to 100

required if discountType is percentage. The discount percentage of this coupon object.

string
enum
required

Discount Type

Allowed:
integer

Time at which the Coupon expires. Measured in milliseconds since the Unix epoch.

integer

Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

metadata
object

Set of up to 20 key-value pairs that you can attach to the object.

string
required
length between 1 and 80

The coupon's name, meant to be displayable to the customer.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json