Deactivate Unique Coupon Code

Deactivate a unique coupon code

DELETE/unique_coupon_codes/{unique_coupon_code_id}

Use it in a workflow

Add a step and choose the Recurly connector.
Pick the Deactivate Unique Coupon Code action (under unique_coupon_code).
Fill in the fields below, then reference the result from later steps as {{deactivateUniqueCouponCode.response.data}}.

Request

Path parameters

unique_coupon_code_idstringrequired

Unique Coupon Code ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-abc-8dh2-def`.

Response

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

idstring

objectstring

codestring

The code the customer enters to redeem the coupon.

statestring

Indicates if the unique coupon code is redeemable or why not.

One ofexpiredinactivemaxed_outredeemable

bulk_coupon_idstring

The Coupon ID of the parent Bulk Coupon

bulk_coupon_codestring

The Coupon code of the parent Bulk Coupon

created_atstring (date-time)

updated_atstring (date-time)

redeemed_atstring (date-time)

The date and time the unique coupon code was redeemed.

expired_atstring (date-time)

The date and time the coupon was expired early or reached its `max_redemptions`.

json

{
  "id": "string",
  "object": "string",
  "code": "string",
  "state": "expired",
  "bulk_coupon_id": "string",
  "bulk_coupon_code": "string",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z",
  "redeemed_at": "2025-01-01T00:00:00Z",
  "expired_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?