Recurly · Schema

Adjustment

SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook

Properties

Name Type Description
account string The URL of the account for the specified adjustment.
invoice string The URL of the invoice for the specified adjustment.
uuid string The unique identifier of the adjustment.
state string The state of the adjustments to return: `pending` or `invoiced`.
description string Description of the adjustment for the adjustment. Max 255 characters.
accounting_code string Accounting code. Max of 20 characters.
origin string The origin of the adjustment to return: `plan`, `plan_trial`, `setup_fee`, `add_on`, `add_on_trial`, `one_time`, `debit`, `credit`, `coupon`, or `carryforward`.
vertex_transaction_type object
unit_amount_in_cents integer Positive amount for a charge, negative amount for a credit. Max 10000000.
quantity string Quantity.
quantity_decimal string A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field sup
original_adjustment_uuid string Only shows if adjustment is a credit created from another credit.
discount_in_cents integer The discount on the adjustment, in cents.
tax_in_cents integer The tax on the adjustment, in cents.
total_in_cents integer The total amount of the adjustment, in cents.
currency string Currency, 3-letter ISO code.
taxable boolean `true` if the current adjustment is taxable, `false` if it is not.
tax_type string The tax type of the adjustment.
tax_region string The tax region of the adjustment.
tax_rate string The tax rate of the adjustment.
origin_tax_address_source object
destination_tax_address_source object
tax_exempt boolean `true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credi
tax_details array The nested address information of the adjustment: `name `, `type`, `tax_rate`, `tax_in_cents`.
tax_code string Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-
start_date string A timestamp associated with when the adjustment began.
end_date string A timestamp associated with when the adjustment ended.
created_at string A timestamp associated with when the adjustment was created.
product_code string For plan related line items this will be the plan's code, for add-on related line items it will be the add-on's code.
subscription string A link to the adjustment's invoice's first subscription (if it exists).
proration_rate number The proration rate is only present on prorated adjustments. It represents how much the adjustment was prorated to account for a mid cycle subscription change.
credit_reason_code string Can be set on POST if adjustment is a credit (unit_amount_in_cents < 0)
shipping_address object The shipping address for this adjustment.
item string If there is an item associated with the adjustment, a link to the resource will be included in the response.
item_code string The `item_code` for the item associated with the adjustment, if there is one. Associates the adjustment with an item and sets related attributes on the adjustment from the default values on the item.
external_sku string The `external_sku` for the item associated with the adjustment, if there is one.
performance_obligation_id object
custom_fields object
type string The type of adjustment to return: `charge` or `credit`.
liability_gl_account_code object
revenue_gl_account_code object
View JSON Schema on GitHub

JSON Schema

recurly-adjustment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/recurly/json-schema/recurly-adjustment-schema.json",
  "title": "Adjustment",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/recurly-adjustments-api-openapi.yml#/components/schemas/Adjustment",
  "allOf": [
    {
      "$ref": "#/$defs/AdjustmentBase"
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "description": "The type of adjustment to return: `charge` or `credit`."
        },
        "liability_gl_account_code": {
          "$ref": "#/$defs/GeneralLedgerAccountCode"
        },
        "revenue_gl_account_code": {
          "$ref": "#/$defs/GeneralLedgerAccountCode"
        }
      }
    }
  ],
  "$defs": {
    "AdjustmentBase": {
      "type": "object",
      "properties": {
        "account": {
          "type": "string",
          "description": "The URL of the account for the specified adjustment."
        },
        "invoice": {
          "type": "string",
          "description": "The URL of the invoice for the specified adjustment."
        },
        "uuid": {
          "type": "string",
          "description": "The unique identifier of the adjustment."
        },
        "state": {
          "type": "string",
          "description": "The state of the adjustments to return: `pending` or `invoiced`."
        },
        "description": {
          "type": "string",
          "description": "Description of the adjustment for the adjustment. Max 255 characters."
        },
        "accounting_code": {
          "type": "string",
          "description": "Accounting code. Max of 20 characters."
        },
        "origin": {
          "type": "string",
          "description": "The origin of the adjustment to return: `plan`, `plan_trial`, `setup_fee`, `add_on`, `add_on_trial`, `one_time`, `debit`, `credit`, `coupon`, or `carryforward`."
        },
        "vertex_transaction_type": {
          "$ref": "#/$defs/VertexTransactionTypeEnum"
        },
        "unit_amount_in_cents": {
          "type": "integer",
          "description": "Positive amount for a charge, negative amount for a credit. Max 10000000."
        },
        "quantity": {
          "type": "string",
          "description": "Quantity."
        },
        "quantity_decimal": {
          "type": "string",
          "title": "Quantity Decimal",
          "description": "A floating-point alternative to Quantity. If this value is present, it will be used in place of Quantity for calculations, and Quantity will be the rounded integer value of this number. This field supports up to 9 decimal places. The Decimal Quantity feature must be enabled to utilize this field."
        },
        "original_adjustment_uuid": {
          "type": "string",
          "description": "Only shows if adjustment is a credit created from another credit."
        },
        "discount_in_cents": {
          "type": "integer",
          "description": "The discount on the adjustment, in cents."
        },
        "tax_in_cents": {
          "type": "integer",
          "description": "The tax on the adjustment, in cents."
        },
        "total_in_cents": {
          "type": "integer",
          "description": "The total amount of the adjustment, in cents."
        },
        "currency": {
          "type": "string",
          "description": "Currency, 3-letter ISO code."
        },
        "taxable": {
          "type": "boolean",
          "description": "`true` if the current adjustment is taxable, `false` if it is not."
        },
        "tax_type": {
          "type": "string",
          "description": "The tax type of the adjustment."
        },
        "tax_region": {
          "type": "string",
          "description": "The tax region of the adjustment."
        },
        "tax_rate": {
          "type": "string",
          "description": "The tax rate of the adjustment."
        },
        "origin_tax_address_source": {
          "$ref": "#/$defs/OriginTaxAddressSourceEnum"
        },
        "destination_tax_address_source": {
          "$ref": "#/$defs/DestinationTaxAddressSourceEnum"
        },
        "tax_exempt": {
          "type": "boolean",
          "description": "`true` exempts tax on the charge, `false` applies tax on the charge. If not defined, then defaults to the Plan and Site settings. This attribute does not work for credits (negative adjustments). Credits are always post-tax. Pre-tax discounts should use the Coupons feature."
        },
        "tax_details": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The nested address information of the adjustment: `name `, `type`, `tax_rate`, `tax_in_cents`."
        },
        "tax_code": {
          "type": "string",
          "maxLength": 50,
          "title": "Tax code",
          "description": "Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes."
        },
        "start_date": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp associated with when the adjustment began."
        },
        "end_date": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp associated with when the adjustment ended."
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "description": "A timestamp associated with when the adjustment was created."
        },
        "product_code": {
          "type": "string",
          "description": "For plan related line items this will be the plan's code, for add-on related line items it will be the add-on's code."
        },
        "subscription": {
          "type": "string",
          "description": "A link to the adjustment's invoice's first subscription (if it exists)."
        },
        "proration_rate": {
          "type": "number",
          "format": "float",
          "description": "The proration rate is only present on prorated adjustments. It represents how much the adjustment was prorated to account for a mid cycle subscription change."
        },
        "credit_reason_code": {
          "type": "string",
          "description": "Can be set on POST if adjustment is a credit (unit_amount_in_cents < 0)"
        },
        "shipping_address": {
          "type": "object",
          "description": "The shipping address for this adjustment."
        },
        "item": {
          "type": "string",
          "description": "If there is an item associated with the adjustment, a link to the resource will be included in the response."
        },
        "item_code": {
          "type": "string",
          "description": "The `item_code` for the item associated with the adjustment, if there is one. Associates the adjustment with an item and sets related attributes on the adjustment from the default values on the item. `<description>`, `<product_code>`, `<accounting_code>`, `<tax_exempt>` and `<tax_code>` are not accepted when `<item_code>` is present."
        },
        "external_sku": {
          "type": "string",
          "description": "The `external_sku` for the item associated with the adjustment, if there is one."
        },
        "performance_obligation_id": {
          "$ref": "#/$defs/PerformanceObligationId"
        },
        "custom_fields": {
          "$ref": "#/$defs/CustomFields"
        }
      }
    },
    "CustomField": {
      "type": "object",
      "required": [
        "name",
        "value"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 50,
          "pattern": "/^[a-z0-9_-]+$/i",
          "title": "Field name",
          "description": "Fields must be created in the UI before values can be assigned to them."
        },
        "value": {
          "type": "string",
          "maxLength": 255,
          "title": "Field value",
          "description": "Any values that resemble a credit card number or security code (CVV/CVC) will be rejected."
        }
      }
    },
    "CustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CustomField"
      },
      "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."
    },
    "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"
      ]
    },
    "GeneralLedgerAccountCode": {
      "type": "string",
      "title": "Accounting code for the ledger account.",
      "description": "Unique code to identify the ledger account. Each code must start\nwith a letter or number. The following special characters are\nallowed: `-_.,:`\n",
      "pattern": "/^[A-Za-z0-9](( *)?[\\-A-Za-z0-9_.,:])*$/",
      "maxLength": 255
    },
    "OriginTaxAddressSourceEnum": {
      "type": "string",
      "title": "Origin tax address source",
      "description": "The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of \"origin\" refers to the \"Business entity tax address\". A value of \"destination\" refers to the \"Customer tax address\".",
      "default": "origin",
      "enum": [
        "origin",
        "destination"
      ]
    },
    "PerformanceObligationId": {
      "type": "string",
      "title": "Performance Obligation ID",
      "description": "The ID of a performance obligation. Performance obligations are\nonly accessible as a part of the Recurly RevRec Standard and\nRecurly RevRec Advanced features.\n",
      "maxLength": 13
    },
    "VertexTransactionTypeEnum": {
      "type": "string",
      "title": "Vertex Transaction Type",
      "description": "Used by Vertex for tax calculations. Possible values are sale, rental, lease.",
      "enum": [
        "sale",
        "rental",
        "lease"
      ]
    }
  }
}

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