Maxio · Schema
CreditNote
BillingSubscriptionRecurring BillingRevenue RecognitionSaaS MetricsPayments
Properties
| Name | Type | Description |
|---|---|---|
| uid | string | Unique identifier for the credit note. It is generated automatically by Chargify and has the prefix "cn_" followed by alphanumeric characters. |
| site_id | integer | ID of the site to which the credit note belongs. |
| customer_id | integer | ID of the customer to which the credit note belongs. |
| subscription_id | integer | ID of the subscription that generated the credit note. |
| number | string | A unique, identifying string that appears on the credit note and in places it is referenced. While the UID is long and not appropriate to show to customers, the number is usually shorter and consumabl |
| sequence_number | integer | A monotonically increasing number assigned to credit notes as they are created. This number is unique within a site and can be used to sort and order credit notes. |
| issue_date | string | Date the credit note was issued to the customer. This is the date that the credit was made available for application, and may come before it is fully applied. The format is `"YYYY-MM-DD"`. |
| applied_date | string | Credit notes are applied to invoices to offset invoiced amounts - they reduce the amount due. This field is the date the credit note became fully applied to invoices. If the credit note has been parti |
| status | object | |
| currency | string | The ISO 4217 currency code (3 character string) representing the currency of the credit note amount fields. |
| memo | string | The memo printed on credit note, which is a description of the reason for the credit. |
| seller | object | |
| customer | object | |
| billing_address | object | |
| shipping_address | object | |
| subtotal_amount | string | Subtotal of the credit note, which is the sum of all line items before discounts or taxes. Note that this is a positive amount representing the credit back to the customer. |
| discount_amount | string | Total discount applied to the credit note. Note that this is a positive amount representing the discount amount being credited back to the customer (i.e., a credit on an earlier discount). For example |
| tax_amount | string | Total tax of the credit note. Note that this is a positive amount representing a previously taxed amount being credited back to the customer (i.e., a credit of an earlier tax). For example, if the ori |
| total_amount | string | The credit note total, which is `subtotal_amount - discount_amount + tax_amount`. |
| applied_amount | string | The amount of the credit note that has already been applied to invoices. |
| remaining_amount | string | The amount of the credit note remaining to be applied to invoices, which is `total_amount - applied_amount`. |
| line_items | array | Line items on the credit note. |
| discounts | array | |
| taxes | array | |
| applications | array | |
| refunds | array | |
| origin_invoices | array | An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://docs.maxio.com/billing/invoicing/working-with-invoices/how-credit-notes-work#how-origin-invoice |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/maxio/json-schema/maxio-credit-note-schema.json",
"title": "CreditNote",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/maxio-advanced-billing-openapi.yml#/components/schemas/CreditNote",
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Unique identifier for the credit note. It is generated automatically by Chargify and has the prefix \"cn_\" followed by alphanumeric characters."
},
"site_id": {
"type": "integer",
"description": "ID of the site to which the credit note belongs.",
"contentEncoding": "int32"
},
"customer_id": {
"type": "integer",
"description": "ID of the customer to which the credit note belongs.",
"contentEncoding": "int32"
},
"subscription_id": {
"type": "integer",
"description": "ID of the subscription that generated the credit note.",
"contentEncoding": "int32"
},
"number": {
"type": "string",
"description": "A unique, identifying string that appears on the credit note and in places it is referenced.\n\nWhile the UID is long and not appropriate to show to customers, the number is usually shorter and consumable by the customer and the merchant alike."
},
"sequence_number": {
"type": "integer",
"description": "A monotonically increasing number assigned to credit notes as they are created. This number is unique within a site and can be used to sort and order credit notes.",
"contentEncoding": "int32"
},
"issue_date": {
"type": "string",
"description": "Date the credit note was issued to the customer. This is the date that the credit was made available for application, and may come before it is fully applied.\n\nThe format is `\"YYYY-MM-DD\"`.",
"contentEncoding": "date"
},
"applied_date": {
"type": "string",
"description": "Credit notes are applied to invoices to offset invoiced amounts - they reduce the amount due. This field is the date the credit note became fully applied to invoices.\n\nIf the credit note has been partially applied, this field will not have a value until it has been fully applied.\n\nThe format is `\"YYYY-MM-DD\"`.",
"contentEncoding": "date"
},
"status": {
"allOf": [
{
"$ref": "#/$defs/CreditNoteStatus"
},
{
"description": "Current status of the credit note."
}
]
},
"currency": {
"type": "string",
"description": "The ISO 4217 currency code (3 character string) representing the currency of the credit note amount fields."
},
"memo": {
"type": "string",
"description": "The memo printed on credit note, which is a description of the reason for the credit."
},
"seller": {
"allOf": [
{
"$ref": "#/$defs/InvoiceSeller"
},
{
"description": "Information about the seller (merchant) listed on the masthead of the credit note."
}
]
},
"customer": {
"allOf": [
{
"$ref": "#/$defs/InvoiceCustomer"
},
{
"description": "Information about the customer who is owner or recipient of the credited subscription."
}
]
},
"billing_address": {
"allOf": [
{
"$ref": "#/$defs/InvoiceAddress"
},
{
"description": "The billing address of the credit subscription."
}
]
},
"shipping_address": {
"allOf": [
{
"$ref": "#/$defs/InvoiceAddress"
},
{
"description": "The shipping address of the credited subscription."
}
]
},
"subtotal_amount": {
"type": "string",
"description": "Subtotal of the credit note, which is the sum of all line items before discounts or taxes. Note that this is a positive amount representing the credit back to the customer."
},
"discount_amount": {
"type": "string",
"description": "Total discount applied to the credit note. Note that this is a positive amount representing the discount amount being credited back to the customer (i.e., a credit on an earlier discount). For example, if the original purchase was $1.00 and the original discount was $0.10, a credit of $0.50 of the original purchase (half) would have a discount credit of $0.05 (also half)."
},
"tax_amount": {
"type": "string",
"description": "Total tax of the credit note. Note that this is a positive amount representing a previously taxed amount being credited back to the customer (i.e., a credit of an earlier tax). For example, if the original purchase was $1.00 and the original tax was $0.10, a credit of $0.50 of the original purchase (half) would also have a tax credit of $0.05 (also half)."
},
"total_amount": {
"type": "string",
"description": "The credit note total, which is `subtotal_amount - discount_amount + tax_amount`."
},
"applied_amount": {
"type": "string",
"description": "The amount of the credit note that has already been applied to invoices."
},
"remaining_amount": {
"type": "string",
"description": "The amount of the credit note remaining to be applied to invoices, which is `total_amount - applied_amount`."
},
"line_items": {
"type": "array",
"items": {
"$ref": "#/$defs/CreditNoteLineItem"
},
"description": "Line items on the credit note."
},
"discounts": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceDiscount"
},
"description": ""
},
"taxes": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceTax"
},
"description": ""
},
"applications": {
"type": "array",
"items": {
"$ref": "#/$defs/CreditNoteApplication"
},
"description": ""
},
"refunds": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceRefund"
},
"description": ""
},
"origin_invoices": {
"type": "array",
"items": {
"$ref": "#/$defs/OriginInvoice"
},
"description": "An array of origin invoices for the credit note. Learn more about [Origin Invoice from our docs](https://docs.maxio.com/billing/invoicing/working-with-invoices/how-credit-notes-work#how-origin-invoices-work)."
}
},
"$defs": {
"CreditNoteApplication": {
"title": "CreditNoteApplication",
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"transaction_time": {
"type": "string",
"contentEncoding": "date-time"
},
"invoice_uid": {
"type": "string"
},
"memo": {
"type": "string"
},
"applied_amount": {
"type": "string"
}
}
},
"CreditNoteLineItem": {
"title": "CreditNoteLineItem",
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "Unique identifier for the line item. Useful when cross-referencing the line against individual discounts in the `discounts` or `taxes` lists."
},
"title": {
"type": "string",
"description": "A short descriptor for the credit given by this line."
},
"description": {
"type": "string",
"description": "Detailed description for the credit given by this line. May include proration details in plain text.\n\nNote: this string may contain line breaks that are hints for the best display format on the credit note."
},
"quantity": {
"type": "string",
"description": "The quantity or count of units credited by the line item.\n\nThis is a decimal number represented as a string. (See \"About Decimal Numbers\".)"
},
"unit_price": {
"type": "string",
"description": "The price per unit for the line item.\n\nWhen tiered pricing was used (i.e., not every unit was actually priced at the same price) this will be the blended average cost per unit and the `tiered_unit_price` field will be set to `true`."
},
"subtotal_amount": {
"type": "string",
"description": "The line subtotal, generally calculated as `quantity * unit_price`. This is the canonical amount of record for the line - when rounding differences are in play, `subtotal_amount` takes precedence over the value derived from `quantity * unit_price` (which may not have the proper precision to exactly equal this amount)."
},
"discount_amount": {
"type": "string",
"description": "The approximate discount of just this line.\n\nThe value is approximated in cases where rounding errors make it difficult to apportion exactly a total discount among many lines. Several lines may have been summed prior to applying the discount to arrive at `discount_amount` for the invoice - backing that out to the discount on a single line may introduce rounding or precision errors."
},
"tax_amount": {
"type": "string",
"description": "The approximate tax of just this line.\n\nThe value is approximated in cases where rounding errors make it difficult to apportion exactly a total tax among many lines. Several lines may have been summed prior to applying the tax rate to arrive at `tax_amount` for the invoice - backing that out to the tax on a single line may introduce rounding or precision errors."
},
"tax_included": {
"type": "boolean",
"description": "Whether the unit price for this line item is tax-inclusive.\n\nWhen `true`, `unit_price` already includes tax and `tax_amount` represents the portion of the price attributable to tax. When `false`, any applicable tax is added on top of the price.\n\nThe value is inherited from the source price point's `tax_included` setting. Custom or ad-hoc line items (which have no associated price point) always return `false`."
},
"total_amount": {
"type": "string",
"description": "The non-canonical total amount for the line.\n\n`subtotal_amount` is the canonical amount for a line. The invoice `total_amount` is derived from the sum of the line `subtotal_amount`s and discounts or taxes applied thereafter. Therefore, due to rounding or precision errors, the sum of line `total_amount`s may not equal the invoice `total_amount`."
},
"tiered_unit_price": {
"type": "boolean",
"description": "When `true`, indicates that the actual pricing scheme for the line was tiered, so the `unit_price` shown is the blended average for all units."
},
"period_range_start": {
"type": "string",
"description": "Start date for the period credited by this line. The format is `\"YYYY-MM-DD\"`.",
"contentEncoding": "date"
},
"period_range_end": {
"type": "string",
"description": "End date for the period credited by this line. The format is `\"YYYY-MM-DD\"`.",
"contentEncoding": "date"
},
"product_id": {
"type": "integer",
"description": "The ID of the product being credited.\n\nThis may be set even for component credits, so true product-only (non-component) credits will also have a nil `component_id`.",
"contentEncoding": "int32"
},
"product_version": {
"type": "integer",
"description": "The version of the product being credited.",
"contentEncoding": "int32"
},
"component_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the component being credited. Will be `nil` for non-component credits.",
"contentEncoding": "int32"
},
"price_point_id": {
"type": [
"integer",
"null"
],
"description": "The price point ID of the component being credited. Will be `nil` for non-component credits.",
"contentEncoding": "int32"
},
"billing_schedule_item_id": {
"type": [
"integer",
"null"
],
"contentEncoding": "int32"
},
"custom_item": {
"type": "boolean"
},
"prepaid_allocation_expires_at": {
"type": [
"string",
"null"
],
"description": "The date a prepaid allocation is set to expire. Only present on line items representing prepaid component allocations. The format is `\"YYYY-MM-DD\"`.",
"contentEncoding": "date"
}
}
},
"CreditNoteStatus": {
"title": "CreditNoteStatus",
"enum": [
"open",
"applied"
],
"type": "string",
"description": "Current status of the credit note."
},
"InvoiceAddress": {
"title": "InvoiceAddress",
"type": "object",
"properties": {
"street": {
"type": [
"string",
"null"
]
},
"line2": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"zip": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
}
}
},
"InvoiceCustomer": {
"title": "InvoiceCustomer",
"type": "object",
"properties": {
"chargify_id": {
"type": [
"integer",
"null"
],
"contentEncoding": "int32"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"organization": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"vat_number": {
"type": [
"string",
"null"
]
},
"reference": {
"type": [
"string",
"null"
]
}
},
"description": "Information about the customer who is owner or recipient of the invoiced subscription."
},
"InvoiceDiscount": {
"title": "InvoiceDiscount",
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"code": {
"type": "string"
},
"source_type": {
"$ref": "#/$defs/InvoiceDiscountSourceType"
},
"source_id": {
"type": "integer",
"contentEncoding": "int32"
},
"discount_type": {
"$ref": "#/$defs/InvoiceDiscountType"
},
"percentage": {
"type": "string"
},
"eligible_amount": {
"type": "string"
},
"discount_amount": {
"type": "string"
},
"transaction_id": {
"type": "integer",
"contentEncoding": "int32"
},
"line_item_breakouts": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceDiscountBreakout"
},
"description": ""
}
}
},
"InvoiceDiscountBreakout": {
"title": "InvoiceDiscountBreakout",
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"eligible_amount": {
"type": "string"
},
"discount_amount": {
"type": "string"
}
}
},
"InvoiceDiscountSourceType": {
"title": "InvoiceDiscountSourceType",
"enum": [
"Coupon",
"Referral",
"Ad Hoc Coupon"
],
"type": "string"
},
"InvoiceDiscountType": {
"title": "InvoiceDiscountType",
"enum": [
"percentage",
"flat_amount",
"rollover"
],
"type": "string"
},
"InvoiceRefund": {
"title": "InvoiceRefund",
"type": "object",
"properties": {
"transaction_id": {
"type": "integer",
"contentEncoding": "int32"
},
"payment_id": {
"type": "integer",
"contentEncoding": "int32"
},
"memo": {
"type": "string"
},
"original_amount": {
"type": "string"
},
"applied_amount": {
"type": "string"
},
"gateway_transaction_id": {
"type": [
"string",
"null"
],
"description": "The transaction ID for the refund as returned from the payment gateway"
},
"gateway_used": {
"type": "string"
},
"gateway_handle": {
"type": [
"string",
"null"
]
},
"ach_late_reject": {
"type": [
"boolean",
"null"
]
}
}
},
"InvoiceSeller": {
"title": "InvoiceSeller",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"address": {
"$ref": "#/$defs/InvoiceAddress"
},
"phone": {
"type": "string"
},
"logo_url": {
"type": [
"string",
"null"
]
}
},
"description": "Information about the seller (merchant) listed on the masthead of the invoice."
},
"InvoiceTax": {
"title": "InvoiceTax",
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"source_type": {
"allOf": [
{
"$ref": "#/$defs/ProformaInvoiceTaxSourceType"
},
{
"description": "The source of the tax. `Tax` is a tax configured in Advanced Billing. The other values identify the tax service that calculated the tax."
}
]
},
"source_id": {
"type": "integer",
"contentEncoding": "int32"
},
"percentage": {
"type": "string"
},
"taxable_amount": {
"type": "string"
},
"tax_amount": {
"type": "string"
},
"transaction_id": {
"type": "integer",
"contentEncoding": "int32"
},
"line_item_breakouts": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceTaxBreakout"
},
"description": ""
},
"tax_component_breakouts": {
"type": "array",
"items": {
"$ref": "#/$defs/InvoiceTaxComponentBreakout"
},
"description": ""
},
"eu_vat": {
"type": "boolean"
},
"type": {
"type": "string"
},
"tax_exempt_amount": {
"type": "string"
}
}
},
"InvoiceTaxBreakout": {
"title": "InvoiceTaxBreakout",
"type": "object",
"properties": {
"uid": {
"type": "string"
},
"taxable_amount": {
"type": "string"
},
"tax_amount": {
"type": "string"
},
"tax_exempt_amount": {
"type": "string"
}
}
},
"InvoiceTaxComponentBreakout": {
"title": "InvoiceTaxComponentBreakout",
"type": "object",
"properties": {
"tax_rule_id": {
"type": "integer",
"contentEncoding": "int32"
},
"percentage": {
"type": "string"
},
"country_code": {
"type": "string"
},
"subdivision_code": {
"type": "string"
},
"tax_amount": {
"type": "string"
},
"taxable_amount": {
"type": "string"
},
"tax_exempt_amount": {
"type": "string"
},
"non_taxable_amount": {
"type": "string"
},
"tax_name": {
"type": "string"
},
"tax_type": {
"type": "string"
},
"rate_type": {
"type": "string"
},
"tax_authority_type": {
"type": "integer",
"contentEncoding": "int32"
},
"state_assigned_no": {
"type": "string"
},
"tax_sub_type": {
"type": "string"
}
}
},
"OriginInvoice": {
"title": "OriginInvoice",
"type": "object",
"properties": {
"uid": {
"type": "string",
"description": "The UID of the invoice serving as an origin invoice."
},
"number": {
"type": "string",
"description": "The number of the invoice serving as an origin invoice."
}
}
},
"ProformaInvoiceTaxSourceType": {
"title": "ProformaInvoiceTaxSourceType",
"enum": [
"Tax",
"Avalara",
"Anrok",
"TaxJar",
"Numeral",
"Sphere",
"Taxwire"
],
"type": "string",
"description": "The source of the tax. `Tax` is a tax configured in Advanced Billing. The other values identify the tax service that calculated the tax."
}
}
}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/maxio-credit-note"
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.