Get List Coupon

curl --request GET 'https://api.mayar.id/hl/v2/coupons?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "coupons": [
            {
                "id": "3f1c8b02-9d4a-4e17-b6c5-0a71d2e93f48",
                "name": "Diskon Awal Tahun",
                "status": "active",
                "discountValue": 50000,
                "totalUsage": 12,
                "createdAt": "2026-01-05T04:21:37.118Z",
                "expiredAt": "2026-12-31T16:59:59.000Z",
                "products": []
            },
            {
                "id": "8a52d7e4-6b30-4c91-9f28-4d6e1b0a75c3",
                "name": "Promo Kelas Online",
                "status": "inactive",
                "discountValue": 25000,
                "totalUsage": 0,
                "createdAt": "2026-02-18T09:44:02.503Z",
                "expiredAt": null,
                "products": [
                    {
                        "id": "6f8c19ff-2b6a-4c7e-9f1d-1a2b3c4d5e6f",
                        "name": "Kelas Online Dasar"
                    }
                ]
            }
        ]
    },
    "hasMore": false,
    "nextStartingAfter": null
}

{
    "statusCode": 400,
    "messages": "Validation Error",
    "data": null
}

{
    "statusCode": 500,
    "messages": "Internal Server Error",
    "data": null
}

curl --request GET 'https://api.mayar.id/hl/v2/coupons?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "coupons": [
            {
                "id": "3f1c8b02-9d4a-4e17-b6c5-0a71d2e93f48",
                "name": "Diskon Awal Tahun",
                "status": "active",
                "discountValue": 50000,
                "totalUsage": 12,
                "createdAt": "2026-01-05T04:21:37.118Z",
                "expiredAt": "2026-12-31T16:59:59.000Z",
                "products": []
            },
            {
                "id": "8a52d7e4-6b30-4c91-9f28-4d6e1b0a75c3",
                "name": "Promo Kelas Online",
                "status": "inactive",
                "discountValue": 25000,
                "totalUsage": 0,
                "createdAt": "2026-02-18T09:44:02.503Z",
                "expiredAt": null,
                "products": [
                    {
                        "id": "6f8c19ff-2b6a-4c7e-9f1d-1a2b3c4d5e6f",
                        "name": "Kelas Online Dasar"
                    }
                ]
            }
        ]
    },
    "hasMore": false,
    "nextStartingAfter": null
}

{
    "statusCode": 400,
    "messages": "Validation Error",
    "data": null
}

{
    "statusCode": 500,
    "messages": "Internal Server Error",
    "data": null
}

Endpoint:

https://api.mayar.id/hl/v2/coupons?limit=10

https://api.mayar.club/hl/v2/coupons?limit=10

Authorization

string

required

Example:Authorization | Bearer Paste-Your-API-Key-Here

Query Parameters

integer

default:"10"

Number of items to return per page. Defaults to 10.

string

Cursor for forward pagination. Pass the nextStartingAfter value from the previous response to fetch the next page.

string

Filter the list by campaign status. Accepted values: active, inactive, expired, upcoming.

string

Filter the list by keyword, matched against the coupon / discount campaign name.

string

Return only the campaigns that apply to the given product (payment link) ID.

Response

Successful Response

Main Structure (Root)

integer

Status code from API.

string

Status message that describes the status code.

object

The list payload, holding the coupons array.

boolean

Information on whether there is additional data to be retrieved (true/false).

string | null

Cursor to pass as startingAfter to fetch the next page. null when there is no further data.

data Structure (Object)

array of object

List of coupons / discount campaigns. Each item is one discount campaign.

coupons Structure (Array Of Object)

string<uuid>

Discount campaign ID.

string

Discount campaign name.

string

Campaign status (active, inactive, expired, or upcoming).

number

Discount value applied by the campaign.

integer

Number of times the campaign’s coupons have been used.

string

Creation time in ISO 8601 format.

string | null

Expiration time in ISO 8601 format, or null when the campaign does not expire.

array of object

Products the campaign applies to (empty when it applies to all products).

coupons.products Structure (Array Of Object)

string<uuid>

Product (payment link) ID the campaign applies to.

string

Name of the product (payment link).

POST Create Installment Create Discount with Coupon

API documentation

Products & payment links

Invoice

Payments

QR / Payment Channels

Transaction

Customer

Membership

Balances

Installment

Discount & Coupon

Bundling

Webhook

Reviews

Credit (Membership / Usage)

SaaS Subscription License

Software License

Authorization

Query Parameters

Response

Main Structure (Root)

data Structure (Object)

coupons Structure (Array Of Object)

coupons.products Structure (Array Of Object)

​Authorization

​Query Parameters

​Response

​Main Structure (Root)

​data Structure (Object)

​coupons Structure (Array Of Object)

​coupons.products Structure (Array Of Object)

Authorization

Query Parameters

Response

Main Structure (Root)

data Structure (Object)

coupons Structure (Array Of Object)

coupons.products Structure (Array Of Object)