Create a coupon

Creates a coupon. A coupon has either an amountOff and currency or percentOff. The coupon created will be automatically synchronized with Stripe if you have a connected stripe account. If you are not connected the endpoint will throw an error. In addition to Checkout Page rate limits, Stripe rate limits apply when creating coupons.

POST/v1/coupons/

Authorization

api_key_auth

AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

label*string

Internal name for the coupon.

Length1 <= length

code*string

The coupon code a customer enters.

Match^[A-Za-z0-9_-]+$

Length1 <= length

amountOff?number

A positive integer representing the amount to subtract from an invoice total (required if percentOff is not passed).

Range0 < value <= 99999999

currency?string

Three-letter ISO code for the currency of the amountOff parameter (required if amountOff is passed).

Value in

"aed" | "aud" | "brl" | "cad" | "chf" | "clp" | "czk" | "dkk" | "eur" | "gbp" | "hkd" | "inr" | "jpy" | "mxn" | "myr" | "nok" | "nzd" | "ron" | "php" | "pln" | "sek" | "sgd" | "usd" | "zar"

duration*string

Value in"once" | "repeating" | "forever"

durationInMonths?number

A positive integer representing the number of months the coupon applies for (required if duration === repeating)

Range0 < value

percentOff?number

A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amountOff is not passed).

Range1 <= value <= 100

appliesToSetupFee?boolean

When enabled, applies this coupon discount to the setup fee.

pageIds?array<>

A list of pageIds that this coupon can be used within.

maxRedemptions?number

The total amount of times this coupon can be used. Doesn't limit a single customer from redeeming multiple times.

Range0 < value

redeemBy?string

The ISO datetime that this coupon must be used before.

Formatdate-time

Response Body

`application/json`

curl -X POST "https://api.checkoutpage.com/v1/coupons/" \  -H "Content-Type: application/json" \  -d '{    "label": "Free shipping within US",    "code": "10Off",    "duration": "once"  }'

{
  "data": {
    "id": "string",
    "label": "Free shipping within US",
    "code": "10Off",
    "amountOff": 0,
    "currency": "string",
    "percentOff": 0,
    "appliesToSetupFee": true,
    "duration": "once",
    "durationInMonths": 0,
    "redeemBy": "2019-08-24T14:15:22Z",
    "maxRedemptions": 0,
    "timesRedeemed": 0,
    "deleted": false,
    "sellerId": "string",
    "pageIds": [
      "string"
    ],
    "stripeCouponId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Empty

Authorization

Request Body

Response Body

201application/json

400

401

403

409

429

500

`application/json`