subotiz-com · Schema
GetInvoiceResponse
PaymentsArtificial IntelligenceBillingSoftware-as-a-ServiceFintechCompany
Properties
| Name | Type | Description |
|---|---|---|
| code | string | error code |
| message | string | error message |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/subotiz-com/json-schema/subotiz-com-get-invoice-response-schema.json",
"title": "GetInvoiceResponse",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/subotiz-com-invoice-api-openapi.yml#/components/schemas/GetInvoiceResponse",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "error code"
},
"message": {
"type": "string",
"description": "error message"
},
"data": {
"$ref": "#/$defs/GetInvoiceResponse_Data"
}
},
"$defs": {
"CurrentPeriodDiscount": {
"type": "object",
"properties": {
"discount_id": {
"type": "string",
"description": "The unique identifier for the discount"
},
"discount_amount": {
"type": "string",
"description": "The amount discounted"
},
"discount_code": {
"type": "string",
"description": "The discount code used"
}
},
"description": "Details for a discount applied in the current period"
},
"Discounts": {
"type": "object",
"properties": {
"current_period": {
"type": "array",
"items": {
"$ref": "#/$defs/CurrentPeriodDiscount"
},
"description": "The current period's discount details"
}
},
"description": "Trade order discount information"
},
"GetInvoiceResponse_Data": {
"type": "object",
"properties": {
"invoice_id": {
"type": "string",
"description": "Invoice ID"
},
"merchant_id": {
"type": "string",
"description": "Merchant ID"
},
"trade_id": {
"type": "string",
"description": "Trade ID"
},
"subscription_id": {
"type": "string",
"description": "Subscription ID"
},
"price_id": {
"type": "string",
"description": "Pricing plan ID"
},
"customer_id": {
"type": "string",
"description": "Subotiz platform `customer_id`"
},
"order_id": {
"type": "string",
"description": "Third-party order number"
},
"original_invoice_id": {
"type": "string",
"description": "Original invoice ID, used for refund invoices to reference the original invoice"
},
"refund_order_id": {
"type": "string",
"description": "Associated refund order ID"
},
"amount": {
"type": "string",
"description": "Payment amount, truncated to two decimal places"
},
"currency": {
"type": "string",
"description": "Currency"
},
"biz_status": {
"type": "string",
"description": "Invoice status:\n- open: Initialized\n- pending: Processing\n- retrying: Retrying\n- success: Payment succeeded\n- failed: Payment failed\n- refunded: Fully refunded\n- partially_refunded: Partially refunded"
},
"invoice_type": {
"type": "string",
"description": "Invoice type:\n- initial: Initial payment\n- trial: Trial period\n- renewal: Subscription renewal\n- refund: Refund"
},
"paid_at": {
"type": "string",
"description": "Payment success time"
},
"cycle_index": {
"type": "integer",
"description": "Current cycle index of the subscription",
"format": "int32"
},
"created_at": {
"type": "string",
"description": "Creation time"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "A set of key-value pairs that can be attached to an object, allowing you to store additional information in a structured format."
},
"Discounts": {
"allOf": [
{
"$ref": "#/$defs/Discounts"
}
],
"description": "Discounts applied to the invoice, including all discount information for this invoice"
},
"price_version_id": {
"type": "string",
"description": "Pricing plan version ID"
},
"tax_amount": {
"type": "string",
"description": "Tax amount"
},
"quantity": {
"type": "string",
"description": "Billing quantity (seat count); null when billing_dimension=usage"
},
"quantity_unit": {
"type": "string",
"description": "Quantity unit name (product-level, default: \"unit\")"
},
"payment_timing": {
"type": "string",
"description": "Payment timing: prepaid - prepaid; postpaid - postpaid"
},
"billing_dimension": {
"type": "string",
"description": "Billing dimension: quantity - by seats / usage - by usage / mixed - mixed (reserved)"
},
"price_type": {
"type": "string",
"description": "Price structure: flat_price / package_price / tiers_price (existing based_on_usage is read-only for legacy)"
},
"quantity_tier_type": {
"type": "string",
"description": "Quantity-tier subtype for purchase-side: common / volume / grading"
},
"price_tier_type": {
"type": "string",
"description": "Price-tier subtype for usage-side: common / volume / grading"
},
"usage_amount": {
"type": "string",
"description": "Package usage amount (package content; shown when price_type=package_price; not actual usage for this period)"
},
"unit_price": {
"type": "string",
"description": "Unit price (per-unit price; when tiers apply, this is the tier's unit price)"
},
"tier_breakdown": {
"type": "array",
"items": {
"$ref": "#/$defs/TierBreakdown"
},
"description": "Per-tier calculation breakdown (exposed for tiers_price pricing)"
},
"usage": {
"type": "string",
"description": "Actual usage for this period (exposed when billing_dimension=usage)"
},
"merchant_price_id": {
"type": "string",
"description": "Merchant-side price ID for this invoice's price; returns the merchant's current configured value. Empty string if not configured."
}
}
},
"TierBreakdown": {
"type": "object",
"properties": {
"tier_order": {
"type": "integer",
"description": "Tier order, starting from 1",
"format": "uint32"
},
"quantity_min": {
"type": "string",
"description": "Lower bound of this tier"
},
"quantity_max": {
"type": "string",
"description": "Upper bound of this tier; empty means unlimited"
},
"units_in_tier": {
"type": "string",
"description": "Quantity / usage that falls into this tier"
},
"unit_price": {
"type": "string",
"description": "Unit price for this tier"
},
"flat_amount": {
"type": "string",
"description": "Flat fee for this tier (same name as the flat_amount column in pricing storage)"
},
"subtotal": {
"type": "string",
"description": "Subtotal for this tier"
}
},
"description": "Per-tier calculation breakdown returned when billing is computed across tiers"
}
}
}
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/subotiz-com-get-invoice-response"
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.