younifyd
Menu

List Account Coupon Redemptions

List the coupon redemptions for an account

GET/accounts/{account_id}/coupon_redemptions

Use it in a workflow

  1. Add a step and choose the Recurly connector.
  2. Pick the List Account Coupon Redemptions action (under coupon_redemption).
  3. Fill in the fields below, then reference the result from later steps as {{listAccountCouponRedemptions.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`.

Query parameters

idsarray<string>

Filter results by their IDs. Up to 200 IDs can be passed at once using commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`. **Important notes:** * The `ids` parameter cannot be used with any other ordering or filtering parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc) * Invalid or unknown IDs will be ignored, so you should check that the results correspond to your request. * Records are returned in an arbitrary order. Since results are all returned at once you can sort the records yourself.

sortstring

Sort field. You *really* only want to sort by `updated_at` in ascending order. In descending order updated records will move behind the cursor and could prevent some records from being returned.

One ofcreated_atupdated_atDefault "created_at"

begin_timestring (date-time)

Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

end_timestring (date-time)

Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`. **Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.

statestring

Filter by state.

One ofactiveinactive

Response

Returns 200 with an object. Read it in later steps with {{listAccountCouponRedemptions.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.