Recurly · Schema

Invoice

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
id string
uuid string
object string
type object Invoices are either charge, credit, or legacy invoices.
origin object The event that created the invoice.
state object
account object
billing_info_id string The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for
subscription_ids array If the invoice is charging or refunding for one or more subscriptions, these are their IDs.
previous_invoice_id string On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https
number string If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will conti
collection_method object An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding trans
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
address object
shipping_address object
currency string 3-letter ISO 4217 currency code.
discount number Total discounts applied to this invoice.
coupon_redemptions array The coupon redemptions applied to this invoice.
subtotal number The summation of charges and credits, before discounts and taxes.
subtotal_after_discount number The summation of charges and credits, after discounts applied.
tax number The total tax on this invoice.
reference_only_currency_conversion object
total number The final total on this invoice. The summation of invoice charges, discounts, credits, and tax.
refundable_amount number The refundable amount on a charge invoice. It will be null for all other invoices.
paid number The total amount of successful payments transaction on this invoice.
balance number The outstanding balance remaining on this invoice.
tax_info object
used_tax_service boolean Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processe
vat_number string VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection met
vat_reverse_charge_notes string VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your ow
terms_and_conditions string This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions.
customer_notes string This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes.
line_items array
has_more_line_items boolean Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint.
transactions array
credit_payments array
created_at string
updated_at string
due_at string Date invoice is due. This is the date the net terms are reached.
closed_at string Date invoice was marked paid or failed.
dunning_campaign_id string Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign.
dunning_events_sent integer Number of times the event was sent.
final_dunning_event boolean Last communication attempt.
business_entity_id string Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled.
custom_fields object
View JSON Schema on GitHub

JSON Schema

recurly-invoice-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-invoice-schema.json",
  "title": "Invoice",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-openapi.yml#/components/schemas/Invoice",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "Invoice ID",
      "readOnly": true
    },
    "uuid": {
      "type": "string",
      "title": "Invoice UUID",
      "readOnly": true
    },
    "object": {
      "type": "string",
      "title": "Object type",
      "readOnly": true
    },
    "type": {
      "title": "Invoice type",
      "description": "Invoices are either charge, credit, or legacy invoices.",
      "$ref": "#/$defs/InvoiceTypeEnum"
    },
    "origin": {
      "title": "Origin",
      "description": "The event that created the invoice.",
      "$ref": "#/$defs/OriginEnum"
    },
    "state": {
      "title": "Invoice state",
      "$ref": "#/$defs/InvoiceStateEnum"
    },
    "account": {
      "$ref": "#/$defs/AccountMini"
    },
    "billing_info_id": {
      "type": "string",
      "title": "Billing info ID",
      "description": "The `billing_info_id` is the value that represents a specific billing info for an end customer. When `billing_info_id` is used to assign billing info to the subscription, all future billing events for the subscription will bill to the specified billing info. `billing_info_id` can ONLY be used for sites utilizing the Wallet feature."
    },
    "subscription_ids": {
      "type": "array",
      "title": "Subscription IDs",
      "description": "If the invoice is charging or refunding for one or more subscriptions, these are their IDs.",
      "items": {
        "type": "string",
        "title": "Subscription ID",
        "maxLength": 13
      }
    },
    "previous_invoice_id": {
      "type": "string",
      "title": "Previous invoice ID",
      "description": "On refund invoices, this value will exist and show the invoice ID of the purchase invoice the refund was created from. This field is only populated for sites without the [Only Bill What Changed](https://docs.recurly.com/docs/only-bill-what-changed) feature enabled. Sites with Only Bill What Changed enabled should use the [related_invoices endpoint](https://recurly.com/developers/api/v2021-02-25/index.html#operation/list_related_invoices) to see purchase invoices refunded by this invoice.",
      "maxLength": 13
    },
    "number": {
      "type": "string",
      "title": "Invoice number",
      "description": "If VAT taxation and the Country Invoice Sequencing feature are enabled, invoices will have country-specific invoice numbers for invoices billed to EU countries (ex: FR1001). Non-EU invoices will continue to use the site-level invoice number sequence."
    },
    "collection_method": {
      "title": "Collection method",
      "description": "An automatic invoice means a corresponding transaction is run using the account's billing information at the same time the invoice is created. Manual invoices are created without a corresponding transaction. The merchant must enter a manual payment transaction or have the customer pay the invoice with an automatic method, like credit card, PayPal, Amazon, or ACH bank payment.",
      "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"
    },
    "address": {
      "$ref": "#/$defs/InvoiceAddress"
    },
    "shipping_address": {
      "$ref": "#/$defs/ShippingAddress"
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "description": "3-letter ISO 4217 currency code.",
      "maxLength": 3
    },
    "discount": {
      "type": "number",
      "format": "float",
      "title": "Discount",
      "description": "Total discounts applied to this invoice."
    },
    "coupon_redemptions": {
      "type": "array",
      "title": "Coupon Redemptions",
      "description": "The coupon redemptions applied to this invoice.",
      "items": {
        "$ref": "#/$defs/CouponRedemptionMini"
      }
    },
    "subtotal": {
      "type": "number",
      "format": "float",
      "title": "Subtotal",
      "description": "The summation of charges and credits, before discounts and taxes."
    },
    "subtotal_after_discount": {
      "type": "number",
      "format": "float",
      "title": "Subtotal After Discount",
      "description": "The summation of charges and credits, after discounts applied."
    },
    "tax": {
      "type": "number",
      "format": "float",
      "title": "Tax",
      "description": "The total tax on this invoice."
    },
    "reference_only_currency_conversion": {
      "$ref": "#/$defs/ReferenceOnlyCurrencyConversion"
    },
    "total": {
      "type": "number",
      "format": "float",
      "title": "Total",
      "description": "The final total on this invoice. The summation of invoice charges, discounts, credits, and tax."
    },
    "refundable_amount": {
      "type": "number",
      "format": "float",
      "title": "Refundable amount",
      "description": "The refundable amount on a charge invoice. It will be null for all other invoices."
    },
    "paid": {
      "type": "number",
      "format": "float",
      "title": "Paid",
      "description": "The total amount of successful payments transaction on this invoice."
    },
    "balance": {
      "type": "number",
      "format": "float",
      "title": "Balance",
      "description": "The outstanding balance remaining on this invoice."
    },
    "tax_info": {
      "$ref": "#/$defs/TaxInfo"
    },
    "used_tax_service": {
      "type": "boolean",
      "title": "Used Tax Service?",
      "description": "Will be `true` when the invoice had a successful response from the tax service and `false` when the invoice was not sent to tax service due to a lack of address or enabled jurisdiction or was processed without tax due to a non-blocking error returned from the tax service."
    },
    "vat_number": {
      "type": "string",
      "title": "VAT number",
      "description": "VAT registration number for the customer on this invoice. This will come from the VAT Number field in the Billing Info or the Account Info depending on your tax settings and the invoice collection method.",
      "maxLength": 20
    },
    "vat_reverse_charge_notes": {
      "type": "string",
      "title": "VAT reverse charge notes",
      "description": "VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription."
    },
    "terms_and_conditions": {
      "type": "string",
      "title": "Terms and conditions",
      "description": "This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin. Specify custom notes to add or override Terms and Conditions."
    },
    "customer_notes": {
      "type": "string",
      "title": "Customer notes",
      "description": "This will default to the Customer Notes text specified on the Invoice Settings. Specify custom notes to add or override Customer Notes."
    },
    "line_items": {
      "type": "array",
      "title": "Line Items",
      "items": {
        "$ref": "#/$defs/LineItem"
      }
    },
    "has_more_line_items": {
      "type": "boolean",
      "title": "Has more Line Items",
      "description": "Identifies if the invoice has more line items than are returned in `line_items`. If `has_more_line_items` is `true`, then a request needs to be made to the `list_invoice_line_items` endpoint."
    },
    "transactions": {
      "type": "array",
      "title": "Transactions",
      "items": {
        "$ref": "#/$defs/Transaction"
      }
    },
    "credit_payments": {
      "type": "array",
      "title": "Credit payments",
      "items": {
        "$ref": "#/$defs/CreditPayment"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "title": "Created at",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "title": "Last updated at",
      "readOnly": true
    },
    "due_at": {
      "type": "string",
      "format": "date-time",
      "title": "Due at",
      "description": "Date invoice is due. This is the date the net terms are reached."
    },
    "closed_at": {
      "type": "string",
      "format": "date-time",
      "title": "Closed at",
      "description": "Date invoice was marked paid or failed."
    },
    "dunning_campaign_id": {
      "type": "string",
      "title": "Dunning Campaign ID",
      "description": "Unique ID to identify the dunning campaign used when dunning the invoice. For sites without multiple dunning campaigns enabled, this will always be the default dunning campaign."
    },
    "dunning_events_sent": {
      "type": "integer",
      "title": "Dunning Event Sent",
      "description": "Number of times the event was sent."
    },
    "final_dunning_event": {
      "type": "boolean",
      "title": "Final Dunning Event",
      "description": "Last communication attempt."
    },
    "business_entity_id": {
      "type": "string",
      "title": "Business Entity ID",
      "description": "Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled."
    },
    "custom_fields": {
      "$ref": "#/$defs/InvoiceCustomFields"
    }
  },
  "$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"
      ]
    },
    "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"
      ]
    },
    "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"
      ]
    },
    "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": [
        "general",
        "gift_card",
        "promotional",
        "refund",
        "service",
        "write_off"
      ]
    },
    "InvoiceAddress": {
      "allOf": [
        {
          "$ref": "#/$defs/Address"
        },
        {
          "$ref": "#/$defs/AddressWithName"
        }
      ],
      "type": "object",
      "properties": {
        "name_on_account": {
          "type": "string",
          "title": "Name on account"
        },
        "company": {
          "type": "string",
          "title": "Company"
        }
      }
    },
    "InvoiceCustomFields": {
      "type": "array",
      "title": "Custom fields",
      "description": "A list of custom fields that were on the account at the time of invoice creation and were marked to be displayed on invoices. Read-only; cannot be set directly on the invoice.",
      "readOnly": true,
      "items": {
        "$ref": "#/$defs/CustomField"
      }
    },
    "InvoiceMini": {
      "type": "object",
      "title": "Invoice mini details",
      "properties": {
        "id": {
          "type": "string",
          "title": "Invoice ID",
          "maxLength": 13
        },
        "object": {
          "type": "string",
          "title": "Object type"
        },
        "number": {
          "type": "string",
          "title": "Invoice number"
        },
        "business_entity_id": {
          "type": "string",
          "title": "Business Entity ID",
          "description": "Unique ID to identify the business entity assigned to the invoice. Available when the `Multiple Business Entities` feature is enabled."
        },
        "type": {
          "title": "Invoice type",
          "$ref": "#/$defs/InvoiceTypeEnum"
        },
        "state": {
          "title": "Invoice state",
          "$ref": "#/$defs/InvoiceStateEnum"
        }
      }
    },
    "InvoiceStateEnum": {
      "type": "string",
      "default": "all",
      "enum": [
        "open",
        "pending",
        "processing",
        "past_due",
        "paid",
        "closed",
        "failed",
        "voided"
      ]
    },
    "InvoiceTypeEnum": {
      "type": "string",
      "enum": [
        "charge",
        "credit",
        "legacy"
      ]
    },
    "KountDecisionEnum": {
      "type": "string",
      "enum": [
        "approve",
        "decline",
        "escalate",
        "review"
      ]
    },
    "LegacyCategoryEnum": {
      "type": "string",
      "enum": [
        "applied_credit",
        "carryforward",
        "charge",
        "credit"
      ]
    },
    "LineItem": {
      "type": "object",
      "title": "Line item",
      "properties": {
        "id": {
          "type": "string",
          "title": "Line item 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
        },
        "type": {
          "title": "Line item type",
          "description": "Charges are positive line items that debit the account. Credits are negative line items that credit the account.",
          "$ref": "#/$defs/LineItemTypeEnum"
        },
        "item_code": {
          "type": "string",
          "title": "Item Code",
          "description": "Unique code to identify an item. Available when the Credit Invoices feature is enabled.",
          "pattern": "/^[a-z0-9_+-]+$/",
          "maxLength": 50
        },
        "item_id": {
          "type": "string",
          "title": "Item ID",
          "description": "System-generated unique identifier for an item. Available when the Credit Invoices feature is enabled.",
          "maxLength": 13
        },
        "external_sku": {
          "type": "string",
          "title": "External SKU",
          "description": "Optional Stock Keeping Unit assigned to an item. Available when the Credit Invoices feature is enabled.",
          "maxLength": 50
        },
        "revenue_schedule_type": {
          "title": "Revenue schedule type",
          "$ref": "#/$defs/LineItemRevenueScheduleTypeEnum"
        },
        "state": {
          "title": "Current state of the line item",
          "description": "Pending line items are charges or credits on an account that have not been applied to an invoice yet. Invoiced line items will always have an `invoice_id` value.",
          "$ref": "#/$defs/LineItemStateEnum"
        },
        "legacy_category": {
          "title": "Legacy category",
          "description": "Category to describe the role of a line item on a legacy invoice:\n- \"charges\" refers to charges being billed for on this invoice.\n- \"credits\" refers to refund or proration credits. This portion of the invoice can be considered a credit memo.\n- \"applied_credits\" refers to previous credits applied to this invoice. See their original_line_item_id to determine where the credit first originated.\n- \"carryforwards\" can be ignored. They exist to consume any remaining credit balance. A new credit with the same amount will be created and placed back on the account.\n",
          "$ref": "#/$defs/LegacyCategoryEnum

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://artifacts.apis.io/recurly/json-schema/recurly-invoice-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-invoice"
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.