Finalize Invoice | PaymentKit

curl -X POST https://app.paymentkit.com/api/account_id/invoices/external_id/finalize \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "inv_8f3b2c9d7a4e",
  "customer_id": "cus_92a1b3d4e5f6",
  "status": "open",
  "currency": "usd",
  "subtotal_amount_atom": 150000,
  "tax_amount_atom": 12000,
  "total_amount_atom": 162000,
  "due_amount_atom": 162000,
  "paid_amount_atom": 0,
  "remaining_amount_atom": 162000,
  "issued_at": "2024-04-10T10:00:00Z",
  "due_date": "2024-05-10T10:00:00Z",
  "description": "Monthly subscription invoice for April 2024",
  "metadata": {
    "project": "Website Redesign",
    "department": "Marketing"
  },
  "created_at": "2024-04-10T09:55:00Z",
  "updated_at": "2024-04-10T10:00:00Z",
  "total_discount_amount_atom": 5000,
  "period_start": "2024-04-01T00:00:00Z",
  "period_end": "2024-04-30T23:59:59Z",
  "collection_method": "charge_automatically",
  "custom_fields": {
    "custom_note": "Thank you for your business"
  },
  "items": [
    {
      "id": "item_01a2b3c4d5e6",
      "invoice_id": "inv_8f3b2c9d7a4e",
      "price": {
        "id": "price_123abc456def",
        "account_id": "acc_789xyz123uvw",
        "product_id": "prod_456def789abc",
        "name": "Monthly Pro Plan",
        "unit_amount_atom": 150000,
        "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": 150000,
              "flat_amount_atom": 0
            }
          ]
        },
        "prerequisite_price_ids": [],
        "exclusive_customer_ids": [],
        "metadata": {
          "feature_set": "all"
        },
        "created_at": "2024-01-01T08:00:00Z",
        "updated_at": "2024-03-01T08:00:00Z",
        "product_name": "Pro Plan Subscription",
        "product_description": "Access to all premium features",
        "custom_fields": {},
        "quantity_divisor": 1
      },
      "description": "Monthly subscription fee for April 2024",
      "quantity": 1,
      "amount": 150000,
      "metadata": {},
      "created_at": "2024-04-10T10:00:00Z",
      "updated_at": "2024-04-10T10:00:00Z",
      "product_name": "Pro Plan Subscription",
      "proration": false,
      "period_start": "2024-04-01T00:00:00Z",
      "period_end": "2024-04-30T23:59:59Z"
    }
  ],
  "invoice_number": 1024,
  "billing_reason": "subscription_cycle",
  "subscription_id": "sub_7a8b9c0d1e2f",
  "invoice_pdf_url": "https://app.paymentkit.com/invoices/inv_8f3b2c9d7a4e.pdf"
}

Finalize an invoice (transition from DRAFT to OPEN).

Triggers PDF generation after finalization.

Requirements:

Invoice must be in DRAFT state

Returns:

The finalized invoice with OPEN status

Finalize an invoice (transition from DRAFT to OPEN). Triggers PDF generation after finalization. Requirements: - Invoice must be in DRAFT state Returns: - The finalized invoice with OPEN status

Authentication

AuthorizationBearer

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

Path parameters

external_idstringRequired

account_idstringRequired

Response

Successful Response

idstring

customer_idstring

statusenum

currencyenum

ISO 4217 currency codes.

subtotal_amount_atominteger or null

tax_amount_atominteger or null

total_amount_atominteger or null

due_amount_atominteger or null

paid_amount_atominteger or null

remaining_amount_atominteger or null

issued_atdatetime

due_datedatetime or null

descriptionstring or null

metadatamap from strings to any or null

created_atdatetime

updated_atdatetime

applied_balance_amount_atominteger or null

total_discount_amount_atominteger or null

period_startdatetime or null

period_enddatetime or null

collection_methodenum or null

Allowed values:

custom_fieldsmap from strings to any or null

Custom field values. Only included when expand=custom_fields is specified.

itemslist of objects or null

invoice_numberinteger or null

billing_reasonenum or null

subscription_idstring or null

invoice_pdf_urlstring or null

receipt_pdf_urlstring or null

Authentication

Path parameters

Response

Errors