Recurly · Schema
UsageList
SubscriptionBillingPaymentsRecurring RevenueInvoicingDunningRevenue RecognitionChurnMCPShopifyWebhook
Properties
| Name | Type | Description |
|---|---|---|
| object | string | Will always be List. |
| has_more | boolean | Indicates there are more results on subsequent pages. |
| next | string | Path to subsequent page of results. |
| data | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/recurly/json-schema/recurly-usage-list-schema.json",
"title": "UsageList",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/recurly-usage-api-openapi.yml#/components/schemas/UsageList",
"type": "object",
"properties": {
"object": {
"type": "string",
"title": "Object type",
"description": "Will always be List."
},
"has_more": {
"type": "boolean",
"description": "Indicates there are more results on subsequent pages."
},
"next": {
"type": "string",
"description": "Path to subsequent page of results."
},
"data": {
"type": "array",
"items": {
"$ref": "#/$defs/Usage"
}
}
},
"$defs": {
"SubscriptionAddOnPercentageTier": {
"type": "object",
"properties": {
"ending_amount": {
"type": "number",
"format": "float",
"title": "Ending amount",
"minimum": 1,
"maximum": 9999999999999.99,
"description": "Ending amount for the tier. Allows up to 2 decimal places. Must be left empty if it is the final tier."
},
"usage_percentage": {
"type": "string",
"title": "Usage Percentage",
"minimum": 0,
"maximum": 100,
"description": "The percentage taken of the monetary amount of usage tracked.\nThis can be up to 4 decimal places represented as a string.\n"
}
}
},
"SubscriptionAddOnTier": {
"type": "object",
"properties": {
"ending_quantity": {
"type": "integer",
"title": "Ending quantity",
"minimum": 1,
"maximum": 999999999,
"description": "Ending quantity for the tier. This represents a unit amount for unit-priced add ons. Must be left empty if it is the final tier."
},
"unit_amount": {
"type": "number",
"format": "float",
"title": "Unit amount",
"minimum": 0,
"maximum": 1000000,
"description": "Allows up to 2 decimal places. Optionally, override the tiers' default unit amount. If add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided."
},
"unit_amount_decimal": {
"type": "string",
"title": "Unit amount decimal",
"description": "Allows up to 9 decimal places. Optionally, override tiers' default unit amount.\nIf `unit_amount_decimal` is provided, `unit_amount` cannot be provided.\nIf add-on's `add_on_type` is `usage` and `usage_type` is `percentage`, cannot be provided.\n"
},
"usage_percentage": {
"type": "string",
"title": "Usage Percentage",
"description": "(deprecated) -- Use the percentage_tiers object instead.",
"deprecated": true
}
}
},
"TierTypeEnum": {
"type": "string",
"title": "Tier type",
"description": "The pricing model for the add-on. For more information,\n[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our\n[Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how\nto configure quantity-based pricing models.\n",
"default": "flat",
"enum": [
"flat",
"tiered",
"stairstep",
"volume"
]
},
"Usage": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"object": {
"type": "string",
"title": "Object type"
},
"merchant_tag": {
"type": "string",
"description": "Custom field for recording the id in your own system associated with the usage, so you can provide auditable usage displays to your customers using a GET on this endpoint."
},
"amount": {
"type": "number",
"format": "float",
"description": "The amount of usage. Can be positive, negative, or 0. If the Decimal Quantity feature is enabled, this value will be rounded to nine decimal places. Otherwise, all digits after the decimal will be stripped. If the usage-based add-on is billed with a percentage, your usage should be a monetary amount formatted in cents (e.g., $5.00 is \"500\")."
},
"usage_type": {
"$ref": "#/$defs/UsageTypeEnum"
},
"tier_type": {
"$ref": "#/$defs/TierTypeEnum"
},
"tiers": {
"type": "array",
"title": "Tiers",
"items": {
"$ref": "#/$defs/SubscriptionAddOnTier"
},
"description": "The tiers and prices of the subscription based on the usage_timestamp. If tier_type = flat, tiers = []"
},
"percentage_tiers": {
"type": "array",
"title": "Percentage Tiers",
"items": {
"$ref": "#/$defs/SubscriptionAddOnPercentageTier"
},
"description": "The percentage tiers of the subscription based on the usage_timestamp. If tier_type = flat, percentage_tiers = []. This feature is currently in development and requires approval and enablement, please contact support."
},
"measured_unit_id": {
"type": "string",
"description": "The ID of the measured unit associated with the add-on the usage record is for."
},
"recording_timestamp": {
"type": "string",
"format": "date-time",
"description": "When the usage was recorded in your system."
},
"usage_timestamp": {
"type": "string",
"format": "date-time",
"description": "When the usage actually happened. This will define the line item dates this usage is billed under and is important for revenue recognition."
},
"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."
},
"unit_amount": {
"type": "number",
"format": "float",
"title": "Unit price"
},
"unit_amount_decimal": {
"type": "string",
"title": "Unit Amount Decimal",
"minimum": 0,
"maximum": 1000000,
"description": "Unit price that can optionally support a sub-cent value."
},
"billed_at": {
"type": "string",
"format": "date-time",
"description": "When the usage record was billed on an invoice."
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "When the usage record was created in Recurly."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "When the usage record was billed on an invoice."
}
}
},
"UsageTypeEnum": {
"type": "string",
"enum": [
"price",
"percentage"
],
"title": "Usage Type",
"description": "Type of usage, returns usage type if `add_on_type` is `usage`."
}
}
}
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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/recurly-usage-list"
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.