subotiz-com Invoice API
The Invoice API from subotiz-com — 2 operation(s) for invoice.
The Invoice API from subotiz-com — 2 operation(s) for invoice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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.curl "https://apis.io/api/v1/apis/subotiz-com:subotiz-com-invoice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
openapi: 3.2.0
info:
title: Subotiz Com Invoice API
version: 1.0.0
description: 'Operations tagged Invoice across 2 of this provider''s published API definitions: subotiz-com-openapi.yml, v1-en.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{api}.subotiz.com
variables:
api:
default: api
security:
- sec0: []
tags:
- name: Invoice
paths:
/api/v1/invoices:
get:
tags:
- Invoice
summary: List Invoices
operationId: v1-invoice-list-invoice
parameters:
- name: invoice_ids
in: query
description: Invoice ID array, filter invoices whose IDs belong to this array
schema:
type: array
items:
type: string
- name: trade_ids
in: query
description: Trade ID array, filter invoices whose Trade IDs belong to this array
schema:
type: array
items:
type: string
- name: order_ids
in: query
description: Order ID array, filter invoices whose Order IDs belong to this array
schema:
type: array
items:
type: string
- name: subscription_id
in: query
description: Subscription ID
schema:
type: string
- name: customer_id
in: query
description: Customer ID
schema:
type: string
- name: biz_status
in: query
description: 'Invoice status array, filter invoices whose status belong to this array
- open: Initial state
- pending: Invoice pending
- retrying: Invoice retrying
- success: Invoice successful
- failed: Invoice failed
- refunded: Invoice fully refunded
- partially_refunded: Invoice partially refunded'
schema:
type: array
items:
type: string
- name: invoice_types
in: query
description: 'Invoice type array, filter invoices whose type belong to this array
- initial: First payment
- trial: Trial period
- renewal: Renewal
- refund: Refund'
schema:
type: array
items:
type: string
- name: starting_after
in: query
description: Cursor for pagination. `starting_after` is the object ID that defines your position in the list. For example, if you want to get the next page, you can use the last object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `ending_before`
schema:
type: string
- name: ending_before
in: query
description: Cursor for pagination. `ending_before` is the object ID that defines your position in the list. For example, if you want to get the previous page, you can use the first object's ID as the parameter value after getting the object list for the first time. Cannot be used together with `starting_after`
schema:
type: string
- name: limit
in: query
description: 'Pagination parameter, number of items per page, default: 10, interface defaults to sorting by creation time in descending order. Limit: [1, 100]'
schema:
type: integer
format: int32
- name: created_at.gt
in: query
description: Minimum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
schema:
type: string
- name: created_at.gte
in: query
description: Minimum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
schema:
type: string
- name: created_at.lt
in: query
description: Maximum value to filter by (exclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
schema:
type: string
- name: created_at.lte
in: query
description: Maximum value to filter by (inclusive, UTC time in RFC3339 format, such as '2025-01-01T00:00:00Z')
schema:
type: string
- name: price_ids
in: query
description: Price ID array, filter invoices whose price_id belongs to this array
schema:
type: array
items:
type: string
- $ref: '#/components/parameters/HeaderRequestID'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListInvoiceResponse'
servers:
- url: https://{api}.subotiz.com
variables:
api:
default: api
/api/v1/invoices/{invoice_id}:
get:
tags:
- Invoice
summary: Get Invoice
operationId: v1-invoice-get-invoice
parameters:
- name: invoice_id
in: path
description: Invoice ID
required: true
schema:
type: string
- $ref: '#/components/parameters/HeaderRequestID'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetInvoiceResponse'
servers:
- url: https://{api}.subotiz.com
variables:
api:
default: api
components:
schemas:
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
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
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:
- open: Initialized
- pending: Processing
- retrying: Retrying
- success: Payment succeeded
- failed: Payment failed
- refunded: Fully refunded
- partially_refunded: Partially refunded'
invoice_type:
type: string
description: 'Invoice type:
- initial: Initial payment
- trial: Trial period
- renewal: Subscription renewal
- 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: '#/components/schemas/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: '#/components/schemas/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.
ListInvoiceResponse:
type: object
properties:
code:
type: string
description: error code
message:
type: string
description: error message
data:
$ref: '#/components/schemas/ListInvoiceResponse_Data'
ListInvoiceResponse_Data:
type: object
properties:
has_more:
type: boolean
description: Whether there is more data
list:
type: array
items:
$ref: '#/components/schemas/Invoice'
description: Invoice list
GetInvoiceResponse:
type: object
properties:
code:
type: string
description: error code
message:
type: string
description: error message
data:
$ref: '#/components/schemas/GetInvoiceResponse_Data'
Invoice:
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:
- open: Initialized
- pending: Processing
- retrying: Retrying
- success: Payment succeeded
- failed: Payment failed
- refunded: Fully refunded
- partially_refunded: Partially refunded'
invoice_type:
type: string
description: 'Invoice type:
- initial: Initial payment
- trial: Trial period
- renewal: Subscription renewal
- 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: '#/components/schemas/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: '#/components/schemas/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.
Discounts:
type: object
properties:
current_period:
type: array
items:
$ref: '#/components/schemas/CurrentPeriodDiscount'
description: The current period's discount details
description: Trade order discount information
parameters:
HeaderRequestID:
name: Request-Id
in: header
description: The unique identifier of the request
required: true
schema:
type: string
default: 008e3967-a1b5-48bb-be14-d5bff5092e61
securitySchemes:
sec0:
type: http
description: 'Bearer API Key authentication. Format: Authorization: Bearer {your_api_key}'
scheme: bearer
x-refined-from:
- subotiz-com-openapi.yml
- v1-en.yaml