Create a Coupon

post

https://testapi.payarc.net/v1/discounts

This API creates coupons that can be used to avail discounts on the invoice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

duration

string

enum

required

The duration for which the subscription invoices are discounted from the time a coupon is redeemed or applied.

Allowed:

name

string

required

Name of the coupon.

amount_off

int32

A number that represents the amount to be subtracted from an invoice total.

percent_off

int32

A number that represents the discount that will be applied when a coupon is used.

discount_id

string

An ID that refers to a coupon when applying to a customer's subscription.

currency

string

Three-letter ISO currency code, in lowercase.

duration_in_months

int32

The duration for which the subscription invoices are discounted from the time a coupon is redeemed or applied.

max_redemptions

int32

Maximum number of times a coupon can be used on subscriptions.

redeem_by

string

Timestamp specifying the last time at which the coupon can be redeemed. After the 'redeem_by date', the coupon can no longer be applied to new subscriptions.

Headers

string

required

Defaults to application/json

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Type

string

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

422422