Raw schema
{
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"id": {
"description": "A Numeral customer id (cus_...) for order tracking / exemptions.",
"type": "string"
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address, line 1."
},
"address_line_2": {
"description": "Street address, line 2 (optional).",
"type": "string"
},
"address_city": {
"type": "string",
"description": "City."
},
"address_province": {
"type": "string",
"description": "State/province/region โ a valid 2-letter ISO 3166-2 subdivision code (e.g. \"CA\")."
},
"address_postal_code": {
"type": "string",
"description": "Postal/ZIP code."
},
"address_country": {
"type": "string",
"description": "Country โ a valid ISO 3166-1 alpha-2 code (e.g. \"US\")."
},
"address_type": {
"type": "string",
"enum": [
"shipping",
"billing"
],
"description": "Address type: \"shipping\" for physical goods, \"billing\" for software/digital goods."
}
},
"required": [
"address_line_1",
"address_city",
"address_province",
"address_postal_code",
"address_country",
"address_type"
],
"description": "Customer address (required)."
}
},
"required": [
"address"
],
"description": "Customer details โ address is required."
},
"order_details": {
"type": "object",
"properties": {
"customer_currency_code": {
"type": "string",
"description": "Currency code. For API version 2024-09-01: \"USD\" or \"CAD\"."
},
"tax_included_in_amount": {
"type": "boolean",
"description": "Do the line-item amounts already include tax? Typically false for North America."
},
"line_items": {
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"description": "Line-item price in the currency's SMALLEST unit (e.g. USD 2000 = $20.00). Tax is calculated against this."
},
"quantity": {
"type": "number",
"description": "Quantity of this product being sold."
},
"reference_product_id": {
"description": "Your product id (required if no product_category).",
"type": "string"
},
"product_category": {
"description": "A tax category from Numeral's taxonomy, e.g. \"GENERAL_MERCHANDISE\", \"SAAS_GENERAL\" (required if no reference_product_id).",
"type": "string"
},
"fallback_product_category": {
"description": "Fallback tax category used when reference_product_id has no matching product in Numeral.",
"type": "string"
},
"reference_line_item_id": {
"description": "Your line-item id (optional; for record keeping).",
"type": "string"
}
},
"required": [
"amount",
"quantity"
]
},
"description": "Order line items (one per product type)."
}
},
"required": [
"customer_currency_code",
"tax_included_in_amount",
"line_items"
],
"description": "Order details."
},
"origin_address": {
"description": "The address a product ships from. Optional on 2024-09-01; required on API version 2025-05-12+.",
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "Street address, line 1."
},
"address_line_2": {
"description": "Street address, line 2 (optional).",
"type": "string"
},
"address_city": {
"type": "string",
"description": "City."
},
"address_province": {
"type": "string",
"description": "State/province/region โ a valid 2-letter ISO 3166-2 subdivision code (e.g. \"CA\")."
},
"address_postal_code": {
"type": "string",
"description": "Postal/ZIP code."
},
"address_country": {
"type": "string",
"description": "Country โ a valid ISO 3166-1 alpha-2 code (e.g. \"US\")."
}
},
"required": [
"address_line_1",
"address_city",
"address_province",
"address_postal_code",
"address_country"
]
},
"metadata": {
"description": "Arbitrary string key/value metadata.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"customer",
"order_details"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}