Create a promotion code

POST

/v1/promotion_code

A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

coupon

string

required

The coupon for this promotion code.

code

string

optional

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. If left blank, we will generate one automatically.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

active

boolean

optional

Whether the promotion code is currently active.

customer

string

optional

The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.

expires_at

string

optional

The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon’s redeems_by.

max_redemptions

integer

optional

A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon’s max_redemptions.

restrictions

object

optional

Settings that restrict the redemption of the promotion code.

first_time_transaction

boolean

optional

A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices

minimum_amount

integer

optional

Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

minimum_amount_currency

string

optional

Three-letter ISO code for minimum_amount

Example

{
    "coupon": "string",
    "code": "string",
    "metadata": {},
    "active": true,
    "customer": "string",
    "expires_at": "string",
    "max_redemptions": 0,
    "restrictions": {
        "first_time_transaction": true,
        "minimum_amount": 0,
        "minimum_amount_currency": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://apitest.wooshpay.com/v1/promotion_code' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "coupon": "string",
    "code": "string",
    "metadata": {},
    "active": true,
    "customer": "string",
    "expires_at": "string",
    "max_redemptions": 0,
    "restrictions": {
        "first_time_transaction": true,
        "minimum_amount": 0,
        "minimum_amount_currency": "string"
    }
}'

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object.

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

active

boolean

optional

Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.

code

string

optional

The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.

coupon

object (Coupons)

optional

Hash describing the coupon for this promotion code.

string

optional

Unique identifier for the object.

amount_off

integer | null

optional

Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

currency

string | null

optional

If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.

duration

enum<string>

optional

One of forever, once, and repeating. Describes how long a customer who applies this coupon will get the discount.

Allowed values:

foreveroncerepeating

duration_in_months

integer

optional

Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

duration_in_weeks

string

required

Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect.

duration_in_days

string

required

Required only if duration is repeating, in which case it must be a positive integer that specifies the number of weeks the discount will be in effect.

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

name

string

optional

Name of the coupon displayed to customers on for instance invoices or receipts.

percent_off

number | null

optional

Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a

100 in v o i ce

50 instead.

max_redemptions

integer | null

optional

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

redeem_by

integer | null

optional

Date after which the coupon can no longer be redeemed.

times_redeemed

integer

optional

Number of times this coupon has been applied to a customer.

valid

boolean

optional

Taking account of the above properties, whether this coupon can still be applied to a customer.

applies_to

object

optional

Contains information about what this coupon applies to.

currency_options

object

optional

Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

customer

null

optional

The customer that this promotion code can be used by.

expires_at

null

optional

Date at which the promotion code can no longer be redeemed.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

max_redemptions

null

optional

Maximum number of times this promotion code can be redeemed.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

restrictions

object

optional

Settings that restrict the redemption of the promotion code.

first_time_transaction

boolean

optional

A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices

minimum_amount

null

optional

Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).

minimum_amount_currency

null

optional

Three-letter ISO code for minimum_amount

times_redeemed

integer

optional

Number of times this promotion code has been used.

Example

{
    "id": "string",
    "object": "string",
    "active": true,
    "code": "string",
    "coupon": {
        "id": "string",
        "amount_off": 0,
        "currency": "string",
        "duration": "forever",
        "duration_in_months": 0,
        "duration_in_weeks": "string",
        "duration_in_days": "string",
        "object": "string",
        "created": 0,
        "livemode": true,
        "metadata": {},
        "name": "string",
        "percent_off": 0,
        "max_redemptions": 0,
        "redeem_by": 0,
        "times_redeemed": 0,
        "valid": true,
        "applies_to": {
            "products": [
                "string"
            ]
        },
        "currency_options": {
            "<currency>.amount_off": 0
        }
    },
    "created": 0,
    "customer": null,
    "expires_at": null,
    "livemode": true,
    "max_redemptions": null,
    "metadata": {},
    "restrictions": {
        "first_time_transaction": true,
        "minimum_amount": null,
        "minimum_amount_currency": null
    },
    "times_redeemed": 0
}

Modified at 2024-05-14 07:22:40

Delete a coupon

Update a promotion code