coupon-redemptions

Stable. Describes behaviour that is built and covered by tests in this repository.

GET `/v1/coupon-redemptions` #

Uses of coupons, newest first

One row per use: the coupon and the code, the customer, what it was used on (the subscription, or the invoice of the purchase) and what it took off. A void or a full refund marks the row reversed.

Parameters

Name	In	Type
`coupon`	query	string
`promotion_code`	query	string
`customer_external_id`	query	string
`page_size`	query	integer
`page_token`	query	string

Responses

Status	Meaning	Body
`200`	OK	ListCouponRedemptionsResponse
`400`	Error envelope	Error

Example response

{
  "redemptions": [
    {
      "id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
      "coupon_code": "string",
      "promotion_code": "string",
      "customer_external_id": "string",
      "target": "COUPON_TARGET_SUBSCRIPTION",
      "target_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
      "invoice_id": "0192f0b4-6f6e-7c3a-9a3e-6a1f2b3c4d5e",
      "discount_minor": "string",
      "bonus_credits": "string",
      "currency": "string",
      "create_time": "2026-11-03T10:15:00Z",
      "reverse_time": "2026-11-03T10:15:00Z"
    }
  ],
  "next_page_token": "string",
  "total": 1
}

curl

curl -X GET https://YOUR-API-ADDRESS/v1/coupon-redemptions \
  -H "Authorization: Bearer $PAYRUDDER_API_KEY"

Models

CouponRedemption

Field	Type	Description
`id` required	string · uuid
`coupon_code` required	string
`promotion_code` required	string	Empty when an operator applied the coupon or it came from a grant
`customer_external_id` required	string
`target` required	`COUPON_TARGET_SUBSCRIPTION` \| `COUPON_TARGET_CREDIT_PURCHASE` \| `COUPON_TARGET_PAYMENT`
`target_id` required	string · uuid	The subscription, or the invoice
`invoice_id` required	string · uuid
`discount_minor` required	string · int64	What it took off; a subscription's grows with each fee
`bonus_credits` required	string · int64
`currency` required	string
`create_time` required	string · date-time
`reverse_time` required	string · date-time	Set when a void or a full refund reversed it, nullable: true

Error

Field	Type	Description
`error` required	object

ListCouponRedemptionsResponse

Field	Type	Description
`redemptions` required	array of CouponRedemption
`next_page_token` required	string
`total` required	integer