API · Get a coupon

API v1

An MCP tool wraps this operation: Recurring billing.

POST /api/v1/getCoupon

What it does#

Returns a single coupon.

Authentication#

Requires the API bearer token in the Authorization header — see authentication.

Parameters#

keystringrequired#

Tilopay integration key.

idstringrequired#

Coupon id.

Request example#

The <...> values are placeholders: replace them with your own credentials and data.

{
  "key": "<api_key>",
  "id": "1"
}

Response#

{
  "type": "200",
  "message": "Success",
  "data": {
    "id": 10788,
    "recurrent_id": 10,
    "code": "E6RMS339",
    "active_users": 1,
    "type_discount": 1,
    "discount": "40.00",
    "expire": "2026-10-20",
    "email_group": 1,
    "email": "cliente@ejemplo.com, otro@ejemplo.com",
    "usage": 1,
    "renews": 2,
    "renews_by_user": 2,
    "usage_counter": 0,
    "created_at": "2026-09-02T20:12:01.000000Z",
    "updated_at": "2026-09-02T20:12:01.000000Z",
    "deleted_at": null
  }
}

To interpret a response that is not a success, see how to read an error response.

Last verified: 2026-10-20

View as raw Markdown