Get Subscription Invoices | PaymentKit

curl https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/invoices \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "items": [
    {
      "id": "inv_8f3b2c9d7a1e4b2f9c6d7e8a",
      "customer_id": "cus_4a7d9e2f1b3c4d5e6f7a8b9c",
      "status": "open",
      "currency": "usd",
      "subtotal_amount_atom": 500000,
      "tax_amount_atom": 40000,
      "total_amount_atom": 540000,
      "due_amount_atom": 540000,
      "paid_amount_atom": 0,
      "remaining_amount_atom": 540000,
      "issued_at": "2024-04-01T10:00:00Z",
      "due_date": "2024-04-15T10:00:00Z",
      "description": "Monthly subscription invoice for Pro Plan",
      "metadata": {
        "order_id": "ord_20240401_001"
      },
      "created_at": "2024-04-01T10:00:00Z",
      "updated_at": "2024-04-01T10:00:00Z",
      "applied_balance_amount_atom": 0,
      "total_discount_amount_atom": 10000,
      "period_start": "2024-03-01T00:00:00Z",
      "period_end": "2024-03-31T23:59:59Z",
      "collection_method": "charge_automatically",
      "custom_fields": {
        "sales_rep": "Jane Doe"
      },
      "items": [
        {
          "id": "item_9a8b7c6d5e4f3a2b1c0d9e8f",
          "invoice_id": "inv_8f3b2c9d7a1e4b2f9c6d7e8a",
          "price": {
            "id": "price_123abc456def789ghi",
            "account_id": "acc_987zyx654wvu321tsr",
            "product_id": "prod_456def789ghi123abc",
            "name": "Pro Plan Monthly Price",
            "unit_amount_atom": 500000,
            "currency": "usd",
            "is_active": true,
            "unit_label": "month",
            "pricing_type": "recurring",
            "recurring_interval": "month",
            "recurring_interval_count": 1,
            "auto_renew": true,
            "contract_term_multiple": 1,
            "trial_days": 14,
            "usage_type": "licensed",
            "billing_scheme": "per_unit",
            "tier_amount_info": {
              "mode": "volume",
              "amount_atoms": [
                {
                  "unit_amount_atom": 500000,
                  "flat_amount_atom": 0
                }
              ]
            },
            "prerequisite_price_ids": [],
            "exclusive_customer_ids": [],
            "metadata": {
              "feature_set": "full"
            },
            "created_at": "2023-12-01T08:00:00Z",
            "updated_at": "2024-03-01T08:00:00Z",
            "product_name": "Pro Plan Monthly",
            "product_description": "Access to all Pro features with monthly billing",
            "custom_fields": {},
            "quantity_divisor": 1
          },
          "description": "Monthly subscription fee",
          "quantity": 1,
          "amount": 500000,
          "metadata": {},
          "created_at": "2024-04-01T10:00:00Z",
          "updated_at": "2024-04-01T10:00:00Z",
          "product_name": "Pro Plan Monthly",
          "proration": false,
          "period_start": "2024-03-01T00:00:00Z",
          "period_end": "2024-03-31T23:59:59Z"
        }
      ],
      "invoice_number": 1024,
      "billing_reason": "subscription_cycle",
      "subscription_id": "sub_7e6f5d4c3b2a1908f7e6d5c4",
      "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a1e4b2f9c6d7e8a.pdf",
      "receipt_pdf_url": "https://app.paymentkit.com/receipts/rcpt_8f3b2c9d7a1e4b2f9c6d7e8a.pdf"
    }
  ],
  "total": 1,
  "has_more": false
}

Get all invoices for a subscription with pagination.

Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency.

Query parameters:

include_items: If true, loads invoice line items (default: false)
Standard pagination params: limit, offset, sortBy, sortOrder, filter, search

Get all invoices for a subscription with pagination. Works for both User and API Key authentication. Account access is automatically validated via endpoint dependency. Query parameters: - include_items: If true, loads invoice line items (default: false) - Standard pagination params: limit, offset, sortBy, sortOrder, filter, search

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

account_idstringRequired

Query parameters

include_itemsbooleanOptionalDefaults to false

limitintegerOptional1-100Defaults to 50

Number of items per page

offsetintegerOptional>=0Defaults to 0

Number of items to skip

filterstringOptionalDefaults to {}

Filter conditions as key-value pairs or advanced filter objects (JSON string)

sortBystring or nullOptional

Field to sort by

sortOrderintegerOptionalDefaults to -1

Sort order: 1 for ascending, -1 for descending

searchstring or nullOptional

Keyword-based search across multiple fields

Response

Successful Response

itemslist of objects

totalinteger

has_moreboolean

Authentication

Path parameters

Query parameters

Response

Errors