Recurly · Schema

Subscription

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string
object string
uuid string The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.
account object
plan object
state object
shipping object
coupon_redemptions array Returns subscription level coupon redemptions that are tied to this subscription.
pending_change object
current_period_started_at string
current_period_ends_at string
current_term_started_at string The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing perio
current_term_ends_at string When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
trial_started_at string
trial_ends_at string
remaining_billing_cycles integer The remaining billing cycles in the current term.
total_billing_cycles integer The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
renewal_billing_cycles integer If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
auto_renew boolean Whether the subscription renews at the end of its term.
ramp_intervals array The ramp intervals representing the pricing schedule for the subscription.
paused_at string Null unless subscription is paused or will pause at the end of the current billing period.
remaining_pause_cycles integer Null unless subscription is paused or will pause at the end of the current billing period.
resume_at string The date the subscription billing resumes following a pause. Null unless the subscription is paused or scheduled to be paused.
currency string 3-letter ISO 4217 currency code.
revenue_schedule_type object
unit_amount number
tax_inclusive boolean Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.
quantity integer
add_ons array
add_ons_total number
subtotal number
tax number Only for merchants using Recurly's In-The-Box taxes.
tax_info object
price_segment_id object
total number
collection_method object
po_number string For manual invoicing, this identifies the PO number associated with the subscription.
net_terms integer Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) tha
net_terms_type object
credit_application_policy object
terms_and_conditions string
customer_notes string
expiration_reason string
custom_fields object
created_at string
updated_at string
activated_at string
canceled_at string
expires_at string
bank_account_authorized_at string Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes in
gateway_code string If present, this subscription's transactions will use the payment gateway with this code.
billing_info_id string Billing Info ID.
active_invoice_id string The invoice ID of the latest invoice created for an active subscription.
business_entity_id string The ID of the business entity associated with the subscription. This will be `null` if the subscription relies on resolving the business entity during renewal.
started_with_gift boolean Whether the subscription was started with a gift certificate.
converted_at string When the subscription was converted from a gift card.
action_result object Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.
View JSON Schema on GitHub

JSON Schema

recurly-subscription-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-subscription-schema.json",
  "title": "Subscription",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-openapi.yml#/components/schemas/Subscription",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "Subscription ID",
      "maxLength": 13
    },
    "object": {
      "type": "string",
      "title": "Object type"
    },
    "uuid": {
      "type": "string",
      "title": "UUID",
      "description": "The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.",
      "maxLength": 32
    },
    "account": {
      "$ref": "#/$defs/AccountMini"
    },
    "plan": {
      "$ref": "#/$defs/PlanMini"
    },
    "state": {
      "title": "State",
      "$ref": "#/$defs/SubscriptionStateEnum"
    },
    "shipping": {
      "$ref": "#/$defs/SubscriptionShipping"
    },
    "coupon_redemptions": {
      "type": "array",
      "title": "Coupon redemptions",
      "description": "Returns subscription level coupon redemptions that are tied to this subscription.",
      "items": {
        "$ref": "#/$defs/CouponRedemptionMini"
      }
    },
    "pending_change": {
      "$ref": "#/$defs/SubscriptionChange"
    },
    "current_period_started_at": {
      "type": "string",
      "format": "date-time",
      "title": "Current billing period started at"
    },
    "current_period_ends_at": {
      "type": "string",
      "format": "date-time",
      "title": "Current billing period ends at"
    },
    "current_term_started_at": {
      "type": "string",
      "format": "date-time",
      "title": "Current term started at",
      "description": "The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods."
    },
    "current_term_ends_at": {
      "type": "string",
      "format": "date-time",
      "title": "Current term ends at",
      "description": "When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date."
    },
    "trial_started_at": {
      "type": "string",
      "format": "date-time",
      "title": "Trial period started at"
    },
    "trial_ends_at": {
      "type": "string",
      "format": "date-time",
      "title": "Trial period ends at"
    },
    "remaining_billing_cycles": {
      "type": "integer",
      "title": "Remaining billing cycles",
      "description": "The remaining billing cycles in the current term."
    },
    "total_billing_cycles": {
      "type": "integer",
      "title": "Total billing cycles",
      "description": "The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire."
    },
    "renewal_billing_cycles": {
      "type": "integer",
      "title": "Renewal billing cycles",
      "description": "If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`."
    },
    "auto_renew": {
      "type": "boolean",
      "default": true,
      "title": "Auto renew",
      "description": "Whether the subscription renews at the end of its term."
    },
    "ramp_intervals": {
      "type": "array",
      "title": "Ramp Intervals",
      "description": "The ramp intervals representing the pricing schedule for the subscription.",
      "items": {
        "$ref": "#/$defs/SubscriptionRampIntervalResponse"
      }
    },
    "paused_at": {
      "type": "string",
      "format": "date-time",
      "title": "Paused at",
      "description": "Null unless subscription is paused or will pause at the end of the current billing period."
    },
    "remaining_pause_cycles": {
      "type": "integer",
      "title": "Remaining pause cycles",
      "description": "Null unless subscription is paused or will pause at the end of the current billing period."
    },
    "resume_at": {
      "type": "string",
      "format": "date-time",
      "title": "Resume at",
      "description": "The date the subscription billing resumes following a pause. Null unless the subscription is paused or scheduled to be paused."
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "description": "3-letter ISO 4217 currency code.",
      "maxLength": 3
    },
    "revenue_schedule_type": {
      "title": "Revenue schedule type",
      "$ref": "#/$defs/RevenueScheduleTypeEnum"
    },
    "unit_amount": {
      "type": "number",
      "format": "float",
      "title": "Subscription unit price"
    },
    "tax_inclusive": {
      "type": "boolean",
      "title": "Tax Inclusive?",
      "description": "Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag."
    },
    "quantity": {
      "type": "integer",
      "title": "Subscription quantity",
      "minimum": 0
    },
    "add_ons": {
      "type": "array",
      "title": "Add-ons",
      "items": {
        "$ref": "#/$defs/SubscriptionAddOn"
      }
    },
    "add_ons_total": {
      "type": "number",
      "format": "float",
      "title": "Total price of add-ons",
      "minimum": 0
    },
    "subtotal": {
      "type": "number",
      "format": "float",
      "title": "Estimated total, before tax.",
      "minimum": 0
    },
    "tax": {
      "type": "number",
      "format": "float",
      "title": "Estimated tax",
      "description": "Only for merchants using Recurly's In-The-Box taxes."
    },
    "tax_info": {
      "$ref": "#/$defs/TaxInfo"
    },
    "price_segment_id": {
      "$ref": "#/$defs/PriceSegmentIdOrCode"
    },
    "total": {
      "type": "number",
      "format": "float",
      "title": "Estimated total"
    },
    "collection_method": {
      "title": "Collection method",
      "default": "automatic",
      "$ref": "#/$defs/CollectionMethodEnum"
    },
    "po_number": {
      "type": "string",
      "title": "Purchase order number",
      "description": "For manual invoicing, this identifies the PO number associated with the subscription.",
      "maxLength": 50
    },
    "net_terms": {
      "type": "integer",
      "title": "Net terms",
      "description": "Integer paired with `Net Terms Type` and representing the number\nof days past the current date (for `net` Net Terms Type) or days after\nthe last day of the current month (for `eom` Net Terms Type) that the\ninvoice will become past due. For `manual` collection method, an additional 24 hours is\nadded to ensure the customer has the entire last day to make payment before\nbecoming past due. For example:\n\nIf an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created.\nIf an invoice is due `net 30`, it will become past due at 31 days exactly.\nIf an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.\n\nFor `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection.\nWhen `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.\n\nFor more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms)\nor visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.",
      "minimum": 0,
      "default": 0
    },
    "net_terms_type": {
      "$ref": "#/$defs/NetTermsTypeEnum"
    },
    "credit_application_policy": {
      "$ref": "#/$defs/CreditApplicationPolicy"
    },
    "terms_and_conditions": {
      "type": "string",
      "title": "Terms and conditions"
    },
    "customer_notes": {
      "type": "string",
      "title": "Customer notes"
    },
    "expiration_reason": {
      "type": "string",
      "title": "Expiration reason"
    },
    "custom_fields": {
      "$ref": "#/$defs/CustomFields"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created at"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Last updated at"
    },
    "activated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Activated at"
    },
    "canceled_at": {
      "type": "string",
      "format": "date-time",
      "title": "Canceled at"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "title": "Expires at"
    },
    "bank_account_authorized_at": {
      "type": "string",
      "format": "date-time",
      "title": "Bank account authorized",
      "description": "Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared."
    },
    "gateway_code": {
      "type": "string",
      "title": "Gateway Code",
      "description": "If present, this subscription's transactions will use the payment gateway with this code.",
      "maxLength": 13
    },
    "billing_info_id": {
      "type": "string",
      "title": "Billing Info ID",
      "description": "Billing Info ID."
    },
    "active_invoice_id": {
      "type": "string",
      "title": "Active invoice ID",
      "description": "The invoice ID of the latest invoice created for an active subscription.",
      "maxLength": 13,
      "readOnly": true
    },
    "business_entity_id": {
      "type": "string",
      "title": "Business Entity ID",
      "description": "The ID of the business entity associated with the subscription. This will be `null` if the subscription relies on resolving the business entity during renewal.",
      "maxLength": 13
    },
    "started_with_gift": {
      "type": "boolean",
      "default": false,
      "description": "Whether the subscription was started with a gift certificate.",
      "title": "Started with Gift"
    },
    "converted_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the subscription was converted from a gift card.",
      "title": "Converted at"
    },
    "action_result": {
      "type": "object",
      "description": "Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.",
      "title": "Action result"
    }
  },
  "$defs": {
    "AccountMini": {
      "type": "object",
      "title": "Account mini details",
      "properties": {
        "id": {
          "type": "string",
          "maxLength": 13,
          "readOnly": true
        },
        "object": {
          "type": "string",
          "title": "Object type",
          "readOnly": true
        },
        "code": {
          "type": "string",
          "description": "The unique identifier of the account.",
          "maxLength": 50
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "The email address used for communicating with this customer.",
          "maxLength": 255
        },
        "first_name": {
          "type": "string",
          "maxLength": 255
        },
        "last_name": {
          "type": "string",
          "maxLength": 255
        },
        "company": {
          "type": "string",
          "maxLength": 255
        },
        "parent_account_id": {
          "type": "string",
          "maxLength": 13
        },
        "bill_to": {
          "type": "string",
          "maxLength": 6
        },
        "dunning_campaign_id": {
          "type": "string",
          "title": "Dunning Campaign ID",
          "description": "Unique ID to identify a dunning campaign. Used to specify if a non-default dunning campaign should be assigned to this account. For sites without multiple dunning campaigns enabled, the default dunning campaign will always be used."
        }
      }
    },
    "AccountTypeEnum": {
      "type": "string",
      "enum": [
        "checking",
        "savings"
      ]
    },
    "ActiveStateEnum": {
      "type": "string",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "AddOnMini": {
      "type": "object",
      "title": "Add-on mini details",
      "description": "Just the important parts.",
      "properties": {
        "id": {
          "type": "string",
          "title": "Add-on ID",
          "maxLength": 13,
          "readOnly": true
        },
        "object": {
          "type": "string",
          "title": "Object type",
          "readOnly": true
        },
        "code": {
          "type": "string",
          "title": "Add-on code",
          "description": "The unique identifier for the add-on within its plan.",
          "maxLength": 50
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "Describes your add-on and will appear in subscribers' invoices.",
          "maxLength": 255
        },
        "add_on_type": {
          "$ref": "#/$defs/AddOnTypeEnum"
        },
        "usage_type": {
          "$ref": "#/$defs/UsageTypeEnum"
        },
        "usage_percentage": {
          "type": "number",
          "format": "float",
          "title": "Usage Percentage",
          "description": "The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0."
        },
        "measured_unit_id": {
          "type": "string",
          "title": "Measured Unit ID",
          "description": "System-generated unique identifier for an measured unit associated with the add-on.",
          "maxLength": 13
        },
        "item_id": {
          "type": "string",
          "title": "Item ID",
          "maxLength": 13,
          "readOnly": true
        },
        "external_sku": {
          "type": "string",
          "title": "External SKU",
          "description": "Optional, stock keeping unit to link the item to other inventory systems.",
          "maxLength": 50,
          "readOnly": true
        },
        "accounting_code": {
          "type": "string",
          "title": "Accounting code",
          "description": "Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code.",
          "pattern": "/^[a-z0-9_+-]+$/",
          "maxLength": 20
        }
      }
    },
    "AddOnSourceEnum": {
      "type": "string",
      "title": "Add-on source",
      "description": "Used to determine where the associated add-on data is pulled from. If this value is set to\n`plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated\n`plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then\nthe associated add-on data will be pulled from the site's item catalog.\n",
      "default": "plan_add_on",
      "enum": [
        "plan_add_on",
        "item"
      ]
    },
    "AddOnTypeEnum": {
      "type": "string",
      "enum": [
        "fixed",
        "usage"
      ],
      "title": "Add-on Type",
      "description": "Whether the add-on type is fixed, or usage-based."
    },
    "Address": {
      "type": "object",
      "properties": {
        "phone": {
          "type": "string",
          "title": "Phone number"
        },
        "street1": {
          "type": "string",
          "title": "Street 1",
          "maxLength": 50
        },
        "street2": {
          "type": "string",
          "title": "Street 2",
          "maxLength": 50
        },
        "city": {
          "type": "string",
          "title": "City"
        },
        "region": {
          "type": "string",
          "title": "State/Province",
          "description": "State or province."
        },
        "postal_code": {
          "type": "string",
          "title": "Zip/Postal code",
          "description": "Zip or postal code."
        },
        "country": {
          "type": "string",
          "title": "Country",
          "description": "Country, 2-letter ISO 3166-1 alpha-2 code."
        },
        "geo_code": {
          "type": "string",
          "maxLength": 20,
          "description": "Code that represents a geographic entity (location or object). Only returned when Vertex or Avalara for Communications is enabled."
        }
      }
    },
    "AddressWithName": {
      "allOf": [
        {
          "$ref": "#/$defs/Address"
        }
      ],
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "title": "First name"
        },
        "last_name": {
          "type": "string",
          "title": "Last name"
        }
      }
    },
    "AvsCheckEnum": {
      "type": "string",
      "enum": [
        "A",
        "B",
        "C",
        "D",
        "E",
        "F",
        "G",
        "H",
        "I",
        "J",
        "K",
        "L",
        "M",
        "N",
        "O",
        "P",
        "Q",
        "R",
        "S",
        "T",
        "U",
        "V",
        "W",
        "X",
        "Y",
        "Z"
      ]
    },
    "BusinessEntityMini": {
      "type": "object",
      "description": "Business entity details",
      "properties": {
        "id": {
          "title": "Business entity ID",
          "type": "string",
          "maxLength": 13,
          "readOnly": true
        },
        "object": {
          "title": "Object type",
          "type": "string",
          "readOnly": true
        },
        "code": {
          "title": "Business entity code",
          "type": "string",
          "maxLength": 50,
          "description": "The entity code of the business entity."
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "This name describes your business entity and will appear on the invoice.",
          "maxLength": 255
        }
      }
    },
    "CardFundingSourceEnum": {
      "type": "string",
      "enum": [
        "credit",
        "debit",
        "charge",
        "prepaid",
        "deferred_debit"
      ]
    },
    "CardNetworkEnum": {
      "type": "string",
      "enum": [
        "Bancontact",
        "CartesBancaires",
        "Dankort",
        "MasterCard",
        "Visa"
      ]
    },
    "CardTypeEnum": {
      "type": "string",
      "enum": [
        "American Express",
        "Dankort",
        "Diners Club",
        "Discover",
        "ELO",
        "Forbrugsforeningen",
        "Hipercard",
        "JCB",
        "Laser",
        "Maestro",
        "MasterCard",
        "Test Card",
        "Union Pay",
        "Unknown",
        "Visa",
        "Tarjeta Naranja"
      ]
    },
    "CollectionMethodEnum": {
      "type": "string",
      "enum": [
        "automatic",
        "manual"
      ]
    },
    "CouponDiscount": {
      "type": "object",
      "description": "Details of the discount a coupon applies. Will contain a `type`\nproperty and one of the following properties: `percent`, `fixed`, `trial`.\n",
      "properties": {
        "type": {
          "$ref": "#/$defs/DiscountTypeEnum"
        },
        "percent": {
          "description": "This is only present when `type=percent`.",
          "type": "integer"
        },
        "currencies": {
          "type": "array",
          "description": "This is only present when `type=fixed`.",
          "items": {
            "$ref": "#/$defs/CouponDiscountPricing"
          }
        },
        "trial": {
          "type": "object",
          "x-class-name": "CouponDiscountTrial",
          "description": "This is only present when `type=free_trial`.",
          "properties": {
            "unit": {
              "title": "Trial unit",
              "description": "Temporal unit of the free trial. When `billing_period`, `length` represents the number of billing cycles.",
              "$ref": "#/$defs/FreeTrialUnitEnum"
            },
            "length": {
              "type": "integer",
              "title": "Trial length",
              "description": "Trial length measured in the units specified by the sibling `unit` property"
            }
          }
        }
      }
    },
    "CouponDiscountPricing": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "title": "Currency",
          "description": "3-letter ISO 4217 currency code.",
          "maxLength": 3
        },
        "amount": {
          "type": "number",
          "format": "float",
          "title": "Discount Amount",
          "description": "Value of the fixed discount that this coupon applies."
        }
      }
    },
    "CouponDurationEnum": {
      "type": "string",
      "enum": [
        "forever",
        "single_use",
        "temporal",
        "billing_periods"
      ]
    },
    "CouponMini": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "Coupon 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."
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "The internal name for the coupon."
        },
        "state": {
          "title": "State",
          "description": "Indicates if the coupon is redeemable, and if it is not, why.",
          "$ref": "#/$defs/CouponStateEnum"
        },
        "discount": {
          "$ref": "#/$defs/CouponDiscount"
        },
        "coupon_type": {
          "title": "Coupon type (TODO: implement coupon generation)",
          "description": "Whether the coupon is \"single_code\" or \"bulk\". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.",
          "$ref": "#/$defs/CouponTypeEnum"
        },
        "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"
        }
      }
    },
    "CouponRedemptionMini": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "Coupon Redemption ID",
          "readOnly": true
        },
        "object": {
          "type": "string",
          "title": "Object type",
          "description": "Will always be `coupon`.",
          "readOnly": true
        },
        "coupon": {
          "$ref": "#/$defs/CouponMini"
        },
        "state": {
          "title": "Coupon Redemption state",
          "$ref": "#/$defs/ActiveStateEnum"
        },
        "remaining_duration": {
          "readOnly": true,
          "$ref": "#/$defs/CouponRedemptionRemainingDuration"
        },
        "discounted": {
          "type": "number",
          "format": "float",
          "title": "Amount Discounted",
          "description": "The amount that was discounted upon the application of the coupon, formatted with the currency."
        },
        "created_at": {
          "type": "string",
          "title": "Created at",
          "format": "date-time",
          "readOnly": true
        }
      }
    },
    "CouponRedemptionRemainingDuration": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "title": "Duration Type",
          "description": "The coupon's duration type. `temporal` includes an `expires_at` timestamp. `billing_periods` includes a `redemptions_remaining` count of billing cycles. `forever` and `single_use` have no additional fields.",
          "$ref": "#/$defs/CouponDurationEnum",
          "readOnly": true
        },
        "expires_at": {
          "type": "string",
          "title": "Expires at",
          "format": "date-time",
          "description": "Present when `type` is `temporal`. The datetime after which this redemption will no longer apply.",
          "readOnly": true
        },
        "redemptions_remaining": {
          "type": "integer",
          "title": "Redemptions Remaining",
          "description": "The number of redemption periods remaining for which this coupon will still apply.",
          "readOnly": true
        }
      }
    },
    "CouponStateEnum": {
      "type": "string",
      "enum": [
        "expired",
        "maxed_out",
        "redeemable"
      ]
    },
    "CouponTypeEnum": {
      "type": "string",
      "enum": [
        "bulk",
        "single_code"
      ]
    },
    "CreditApplicationAllowedOriginTypeEnum": {
      "type": "string",
      "title": "Credit Application Allowed Origin Type",
      "description": "The origin type of a credit invoice that can be allowed in a credit application policy",
      "enum": [
        "line_item_refund",
        "open_amount_refund",
        "immediate_change",
        "termination",
        "credit",
        "write_off",
        "refund",
        "external_refund",
        "carryforward_credit",
        "usage_correction",
        "prepayment",
        "gift_card",
        "carryforward_gift_credit"
      ]
    },
    "CreditApplicationModeEnum": {
      "type": "string",
      "title": "Credit Application Mode",
      "description": "Determines which credit invoices are applied to invoices:\n- `all`: All available credit invoices are applied (default)\n- `none`: No credit invoices are applied automatically\n",
      "enum": [
        "all",
        "none"
      ],
      "default": "all"
    },
    "CreditApplicationPolicy": {
      "type": "object",
      "title": "Credit Application Policy",
      "description": "Controls whether credit invoices are automatically applied to new invoices.\nThe `mode` field determines the application behavior. When mode is `all`,\nthe optional `allowed_origins` array can restrict which credit invoice origins\nare applied.\n",
      "properties": {
        "mode": {
          "$ref": "#/$defs/CreditApplicationModeEnum"
        },
        "allowed_origins": {
          "type": "array",
          "description": "Optional array of credit invoice origin types to allow when mode is `all`.\nIf not specified when mode is `all`, credits from all origins are applied.\nOnly valid when mode is `all`.\n",
          "items": {
            "$ref": "#/$defs/CreditApplicationAllowedOriginTypeEnum"
          }
        }
      },
      "required": [
        "mode"
      ]
    },
    "CreditPayment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "title": "Credit Payment ID",
          "maxLength": 13
        },
        "object": {
          "type": "string",
          "title": "Object type"
        },
        "uuid": {
          "type": "string",
          "title": "Recurly UUID",
          "description": "The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.",
          "maxLength": 32
        },
        "action": {
          "title": "Action",
          "description": "The action for which the credit was created.",
          "$ref": "#/$defs/CreditPaymentActionEnum"
        },
        "account": {
          "$ref": "#/$defs/AccountMini"
        },
        "applied_to_invoice": {
          "$ref": "#/$defs/InvoiceMini"
        },
        "original_invoice": {
          "$ref": "#/$defs/InvoiceMini"
        },
        "currency": {
          "type": "string",
          "title": "Currency",
          "description": "3-letter ISO 4217 currency code.",
          "maxLength": 3
        },
        "amount": {
          "type": "number",
          "format": "float",
          "title": "Amount",
          "description": "Total credit payment amount applied to the charge invoice."
        },
        "original_credit_payment_id": {
          "type": "string",
          "title": "Original Credit Payment ID",
          "description": "For credit payments with action `refund`, this is the credit payment that was refunded.",
          "maxLength": 13
        },
        "refund_transaction": {
          "$ref": "#/$defs/Transaction"
        },
        "created_at": {
          "type": "string",
          "title": "Created at",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "title": "Last updated at",
          "format": "date-time",
          "readOnly": true
        },
        "voided_at": {
          "type": "string",
          "title": "Voided at",
          "format": "date-time",
          "readOnly": true
        }
      }
    },
    "CreditPaymentActionEnum": {
      "type": "string",
      "enum": [
        "payment",
        "reduction",
        "refund",
        "write_off"
      ]
    },
    "CustomField": {
      "type": "object",
      "title": "Custom field",
      "properties": {
        "name": {
          "type": "string",
          "title": "Field name",
          "description": "Fields must be created in the UI before values can be assigned to them.",
          "pattern": "/^[a-z0-9_-]+$/i",
          "maxLength": 50
        },
        "value": {
          "type": "string",
          "title": "Field value",
          "description": "Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.",
          "maxLength": 255
        },
        "source_record_type": {
          "type": "string",
          "title": "Source record type",
          "description": "The type of record this custom field was automatically copied from. Only present when the field was copied from another record.",
          "readOnly": true,
          "$ref": "#/$defs/SourceRecordTypeEnum"
        },
        "source_record_id": {
          "type": "string",
          "title": "Source record ID",
          "description": "The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.",
          "readOnly": true
        }
      },
      "required": [
        "name",
        "value"
      ]
    },
    "CustomFields": {
      "type": "array",
      "title": "Custom fields",
      "description": "The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.",
      "items": {
        "$ref": "#/$defs/CustomField"
      }
    },
    "CvvCheckEnum": {
      "type": "string",
      "enum": [
        "D",
        "I",
        "M",
        "N",
        "P",
        "S",
        "U",
        "X"
      ]
    },
    "DestinationTaxAddressSourceEnum": {
      "type": "string",
      "title": "Destination tax address source",
      "description": "The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of \"destination\" refers to the \"Customer tax address\". A value of \"origin\" refers to the \"Business entity tax address\".",
      "default": "destination",
      "enum": [
        "destination",
        "origin"
      ]
    },
    "DiscountTypeEnum": {
      "type": "string",
      "enum": [
        "fixed",
        "free_trial",
        "percent"
      ]
    },
    "FraudRiskRule": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "title": "The Kount rule number."
        },
        "message": {
          "type": "string",
          "title": "Description of why the rule was triggered"
        }
      }
    },
    "FreeTrialUnitEnum": {
      "type": "string",
      "enum": [
        "day",
        "month",
        "week",
        "billing_period"
      ]
    },
    "FullCreditReasonCodeEnum": {
      "type": "string",
      "enum":

# --- truncated at 32 KB (109 KB total) ---
# Full source: https://artifacts.apis.io/recurly/json-schema/recurly-subscription-schema.json

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-subscription"
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.