Create a coupon

post

https://test-api.acquired.com/v1/coupons

Create a new coupon with a discount configuration.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 256

A display name for the coupon.

discount_type

string

enum

required

The type of discount. 'percentage' applies a percentage reduction. 'fixed_amount' applies a fixed currency reduction.

Allowed:

value

number

required

> 0

The discount value. For percentage: 20 = 20% (max 100 = 100%). For fixed_amount: 5.00 = 5.00 in the specified currency.

currency

string | null

enum

Required for fixed_amount discounts. Must be null for percentage discounts.

Allowed:

duration

string

enum

required

How long the discount applies when used on a subscription.

Allowed:

duration_in_cycles

integer | null

≥ 1

Number of billing cycles the discount applies for. Required when duration is 'repeating'. Must be null otherwise.

max_redemptions

integer | null

≥ 1

Maximum number of times this coupon can be applied across all subscriptions. Null for unlimited.

Responses

200Coupon Created