comecerodocs
Subscriptions

List subscription invoices

GET
/subscriptions/{subscription_id}/invoices

Lists the invoices of a subscription, one per billing period plus any made for item changes. Together they are the subscription's billing history. Draft invoices are left out. The list is offset-based. Secret, trusted and limited tokens may call it; a limited token only for the customer it is signed in as.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

subscription_id*string

The subscription id.

Query Parameters

open?boolean

Only invoices that are, or are not, open (still to be paid).

payment_status?string

Only invoices with this payment status.

Value in"unpaid""scheduled""initiated""processing""pending""completed""failed""cancelled""refunded""retry"
q?string

Only the invoice with this exact id.

sort_by?string

The field to sort by.

Default"date_created"
Value in"date_created""date_modified""date_completed"
limit?integer

How many items to return on one page, from 1 to 100. The default is 100. A value outside 1 to 100, or one that is not a whole number, is a 400.

Range1 <= value <= 100
Default100
offset?integer

For offset-based lists, how many items to skip before the page starts. Use next_page_offset or previous_page_offset from the page you have. A value that is not a whole number is a 400.

Range0 <= value
Default0
desc?boolean

Sort in descending order (newest, largest or last first) when true. The default is false. A value other than true or false is a 400.

Defaultfalse
expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

show?string

Comma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

hide?string

Comma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

A page of invoices.

application/json
  1. response

An offset-based list of invoices.

total_items?integer

The number of items in the whole list.

total_pages?integer

The number of pages.

current_page?integer

The page number of this page, starting at 1.

next_page_url?|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset?|

The offset of the next page, or null on the last page.

previous_page_url?|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset?|

The offset of the previous page, or null on the first page.

current_page_url?string

The URL of this page.

Formaturi
data?array<>

The items on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/subscriptions/string/invoices'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/subscriptions/0093799318129SuLByRPW8/invoices?offset=0&limit=10",  "data": [    {      "object": "invoice",      "url": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639",      "date_created": "2026-11-02T15:04:11Z",      "date_modified": "2026-11-02T15:10:42Z",      "date_due": "2026-11-30T00:00:00Z",      "past_due": false,      "invoice_id": "4827-KTPMW-639",      "test": true,      "account_id": "AB1234",      "order_id": "4827-KTPMW-639",      "open": true,      "payment_status": "unpaid",      "currency": "USD",      "subtotal": 950,      "subtotal_original": 950,      "shipping": 0,      "shipping_original": 0,      "discount": 0,      "item_discounts": 0,      "total_discounts": 0,      "total_discounts_percent": 0,      "tax": 0,      "tax_original": 0,      "total": 950,      "total_original": 950,      "tax_inclusive": false,      "total_payments": 0,      "total_remaining": 950,      "discount_on_gross": false,      "autopay": false,      "for_subscription_proration": false,      "autopay_at": null,      "settlement_currency": "USD",      "settlement_subtotal": 950,      "settlement_subtotal_original": 950,      "settlement_shipping": 0,      "settlement_shipping_original": 0,      "settlement_discount": 0,      "settlement_item_discounts": 0,      "settlement_total_discounts": 0,      "settlement_tax": 0,      "settlement_tax_original": 0,      "settlement_total": 950,      "customer_ip_address": null,      "customer_ip_country": null,      "referrer": null,      "affiliate_id": null,      "promotion_code": null,      "items_count": 1,      "items_quantity": 10,      "draft": false,      "items": [        {          "object": "invoice_item",          "url": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639/items/1",          "item_id": "1",          "invoice_id": "4827-KTPMW-639",          "cross_sell_id": null,          "up_sell_id": null,          "bundle_id": null,          "bundle_group_id": null,          "date_created": "2026-11-02T15:04:11Z",          "date_modified": "2026-11-02T15:04:11Z",          "product_id": null,          "name": "Website setup, 10 hours",          "type": "service",          "quantity": 10,          "currency": "USD",          "price": 95,          "price_original": 95,          "reference_price": 95,          "reference_currency": "USD",          "subtotal": 950,          "subtotal_original": 950,          "discount": 0,          "discount_percent": 0,          "tax": 0,          "tax_original": 0,          "total": 950,          "total_original": 950,          "tax_rate": 0,          "tax_code": null,          "product": null,          "subscription_plan": null,          "subscription_terms": null,          "meta": null        }      ],      "shipping_item": null,      "customer": {        "object": "customer",        "url": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3",        "customer_id": "0091304300408CuoxY9Pf3",        "date_created": "2026-11-02T18:18:20Z",        "date_modified": "2026-11-02T18:18:20Z",        "account_id": "AB1234",        "test": true,        "company_name": null,        "name": "John Doe",        "email": "john@example.com",        "phone": "555-555-0123",        "billing_address": {          "object": "address",          "name": "John Doe",          "address_1": "100 Main Street",          "address_2": null,          "city": "Springfield",          "state_prov": "IL",          "postal_code": "62701",          "country": "US",          "email": "john@example.com",          "meta": null        },        "shipping_address": {          "object": "address",          "name": null,          "address_1": null,          "address_2": null,          "city": null,          "state_prov": null,          "postal_code": null,          "country": null,          "email": null,          "meta": null        },        "username": "johndoe",        "tax_number": null,        "tax_exempt": false,        "has_payments": true,        "locale": "en-US",        "meta": null,        "payment_methods": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/payment_methods",        "payments": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/payments",        "refunds": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/refunds",        "orders": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/orders",        "subscriptions": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/subscriptions",        "invoices": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/invoices",        "balance": "https://api.comecero.com/api/v1/customers/0091304300408CuoxY9Pf3/balance"      },      "order": null,      "payments": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639/payments",      "subscription": null,      "subscription_date_period_start": null,      "subscription_date_period_end": null,      "promotions": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639/promotions",      "options": "https://api.comecero.com/api/v1/invoices/4827-KTPMW-639/options",      "meta": {        "project": "Q4-site"      }    }  ]}

Get subscription history GET

Returns the change log of a subscription: who changed what and when. Core keeps the last 100 entries. Secret and trusted tokens may call it; a limited token may not (`403`).

List subscription items GET

Returns the items of a subscription, including cancelled ones, as a plain JSON array (no paging wrapper). `limit` and `offset` slice the array. Secret, trusted and limited tokens may call it; a limited token only for the customer it is signed in as.