Recurly · Schema

UniqueCouponCode

A unique coupon code for a bulk coupon.

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string
object string
code string The code the customer enters to redeem the coupon.
state object Indicates if the unique coupon code is redeemable or why not.
bulk_coupon_id string The Coupon ID of the parent Bulk Coupon
bulk_coupon_code string The Coupon code of the parent Bulk Coupon
created_at string
updated_at string
redeemed_at string The date and time the unique coupon code was redeemed.
expired_at string The date and time the coupon was expired early or reached its `max_redemptions`.
redeem_by_date string Absolute expiry computed and stored at code-generation time. Set only for Window (relative redeem-by) coupons. Null for Anytime coupons and Specific Date coupons — those resolve expiry from the parent
View JSON Schema on GitHub

JSON Schema

recurly-unique-coupon-code-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-unique-coupon-code-schema.json",
  "title": "UniqueCouponCode",
  "description": "A unique coupon code for a bulk coupon.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-unique-coupon-code-api-openapi.yml#/components/schemas/UniqueCouponCode",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "Unique Coupon Code ID",
      "readOnly": true
    },
    "object": {
      "type": "string",
      "title": "Object type",
      "readOnly": true
    },
    "code": {
      "type": "string",
      "title": "Coupon code",
      "description": "The code the customer enters to redeem the coupon."
    },
    "state": {
      "title": "State",
      "description": "Indicates if the unique coupon code is redeemable or why not.",
      "$ref": "#/$defs/CouponCodeStateEnum"
    },
    "bulk_coupon_id": {
      "type": "string",
      "title": "Bulk Coupon ID",
      "description": "The Coupon ID of the parent Bulk Coupon",
      "readOnly": true
    },
    "bulk_coupon_code": {
      "type": "string",
      "title": "Bulk Coupon code",
      "description": "The Coupon code of the parent Bulk Coupon"
    },
    "created_at": {
      "type": "string",
      "title": "Created at",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "title": "Updated at",
      "format": "date-time",
      "readOnly": true
    },
    "redeemed_at": {
      "type": "string",
      "title": "Redeemed at",
      "description": "The date and time the unique coupon code was redeemed.",
      "format": "date-time",
      "readOnly": true
    },
    "expired_at": {
      "type": "string",
      "title": "Expired at",
      "description": "The date and time the coupon was expired early or reached its `max_redemptions`.",
      "format": "date-time"
    },
    "redeem_by_date": {
      "type": "string",
      "title": "Redeem by",
      "description": "Absolute expiry computed and stored at code-generation time. Set only for Window (relative redeem-by) coupons. Null for Anytime coupons and Specific Date coupons — those resolve expiry from the parent coupon's redeem_by at redemption time, not at code-generation time.",
      "format": "date-time",
      "readOnly": true
    }
  },
  "$defs": {
    "CouponCodeStateEnum": {
      "type": "string",
      "enum": [
        "expired",
        "inactive",
        "maxed_out",
        "redeemable"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/recurly-unique-coupon-code"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.