Create a coupons

post

https://api.piriod.com/coupons/

Creates a new Coupon object.

Body Params

amount

float

required

A positive number representing the amount of the coupon.

apply_on

string

Defaults to invoice

Can be line or invoice. Line allow apply the coupon only to Subscription Line objects. Invoice allow apply the coupon only to Subscription objects.

currency

string

required

Three-letter ISO code for the currency of the coupon.

discount_scheme

string

Defaults to %

Can be $ or %. $ apply amount as discount. % apply percentage as discount.

duration_scheme

string

Defaults to one_time

Can be one_time, forever or limited. One time will apply the coupon on the first subscription billing after adding the coupon. Forever will apply the coupon to all subscription billing after adding the coupon. Limited will apply the coupon to subscription billing according to value specified in duration_times attribute.

duration_times

int32

Required if duration_scheme attribute is limited. Determines how many times the coupon should be applied after being added.

name

string

required

A human identifier for the coupon with a 56 characters as max length. This is used to help you to manage coupons in your account.

valid_until

date

Date that determines until when the coupon can be applied to new subscriptions.

Response

200200