List Active Coupon Redemptions

List the coupon redemptions that are active on an account

GET/accounts/{account_id}/coupon_redemptions/active

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the List Active Coupon Redemptions action (under coupon_redemption).
Fill in the fields below, then reference the result from later steps as {{listActiveCouponRedemptions.response.data}}.

Request

Path parameters

account_idstringrequired

Account ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-bob`.

Response

Returns 200 with an object. Read it in later steps with {{listActiveCouponRedemptions.response.data.<field>}}.

objectstring

Will always be List.

has_moreboolean

Indicates there are more results on subsequent pages.

nextstring

Path to subsequent page of results.

dataarray<object>

idstring

objectstring

Will always be `coupon`.

uuidstring

The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

accountobject10 fields

subscription_idstring

couponobject29 fields

statestring

One ofactiveinactiveDefault "active"

remaining_durationobject3 fields

currencystring

3-letter ISO 4217 currency code.

discountednumber (float)

The amount that was discounted upon the application of the coupon, formatted with the currency.

created_atstring (date-time)

updated_atstring (date-time)

removed_atstring (date-time)

The date and time the redemption was removed from the account (un-redeemed).

json

{
  "object": "string",
  "has_more": false,
  "next": "string",
  "data": [
    {
      "id": "string",
      "object": "string",
      "uuid": "string",
      "account": {
        "id": "string",
        "object": "string",
        "code": "string",
        "email": "name@example.com",
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "parent_account_id": "string",
        "bill_to": "string",
        "dunning_campaign_id": "string"
      },
      "subscription_id": "string",
      "coupon": {
        "id": "string",
        "object": "string",
        "code": "string",
        "name": "string",
        "state": "expired",
        "max_redemptions": 0,
        "max_redemptions_per_account": 0,
        "unique_coupon_codes_count": 0,
        "unique_code_template": "string",
        "unique_coupon_code": {},
        "duration": "forever",
        "temporal_amount": 0
      },
      "state": "active",
      "remaining_duration": {
        "type": "forever",
        "expires_at": "2025-01-01T00:00:00Z",
        "redemptions_remaining": 0
      },
      "currency": "string",
      "discounted": 0,
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z"
    }
  ]
}

Need more? See the Recurly guide for connection setup and behaviour shared by every action.

Was this page helpful?