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

Body Params application/json

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

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