MEmeteroid-oss
Invoices

Refresh invoice

Changed on

Recompute a draft invoice against current usage, credits, coupons and tax, and return it. Drafts are also refreshed periodically in the background; use this to force it, e.g. after ingesting late events. Rejected while a payment for the invoice is in progress or when the invoice was merged into a consolidated parent.

post/api/v1/invoices/{invoice_id}/refresh

Request

Path parameters

invoice_idstring MeteroidId required
Example:inv_7n42DGM5Tflk9n8mt7Fhc7

Invoice ID

Response

Refreshed invoice

amount_dueinteger required
applied_creditsinteger required

Paid credit applied after tax, in minor units of the invoice currency: it settles part of total like a payment, and amount_due is net of it.

billing_period_startstring date nullable

The period/moment this invoice is about — the subscription period start, or the invoice's own date for manual/one-off. Stable and always present, distinct from invoice_date (the emission date). Shown as "Invoice date".

child_invoice_idstring MeteroidId
created_atstring date-time required
currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' required
custom_propertiesunknown required
customer_idstring MeteroidId required
due_datestring date nullable
einvoicing_status'GENERATED' | 'FAILED'

Whether the structured e-invoice was produced with the accounting PDF. Absent when the invoicing entity had not opted in at the time the invoice was issued.

finalized_atstring date-time nullable
idstring MeteroidId required
invoice_datestring date required
invoice_numberstring required
invoice_type'RECURRING' | 'ONE_OFF' | 'ADJUSTMENT' | 'USAGE_THRESHOLD' required
marked_as_uncollectible_atstring date-time nullable
memostring nullable
net_termsinteger required
paid_atstring date-time nullable
parent_invoice_idstring MeteroidId
payment_disputed_atstring date-time nullable

When a dispute or chargeback first took money still lost on this invoice's payments. The invoice stays paid; absent when nothing is disputed.

payment_status'UNPAID' | 'PARTIALLY_PAID' | 'PAID' | 'ERRORED' | 'PROCESSING' required
promotional_creditsinteger

Promotional credit applied before tax (credit included with the plan, coupon credit, bonus credit), in minor units of the invoice currency. Like a discount, it reduces the taxable amount: tax_amount and total already exclude it, subtotal does not. Unlike applied_credits, which settles part of the total after tax.

purchase_orderstring nullable
referencestring nullable
settled_by_credit_notesboolean required

True when the invoice is PAID without any payment: finalized credit notes cancelled its whole total. Nothing was collected, so it books no cash.

status'DRAFT' | 'FINALIZED' | 'UNCOLLECTIBLE' | 'VOID' | 'CLOSED' required
subscription_idstring MeteroidId
subtotalinteger required
subtotal_recurringinteger required
tax_amountinteger required
tax_inclusiveboolean required

The prices billed were quoted tax-included. Amounts are net regardless: the tax was carved out of the quoted price, so total is that price to the unit.

totalinteger required
updated_atstring date-time nullable
voided_atstring date-time nullable

Example response

{
  "child_invoice_id": "inv_7n42DGM5Tflk9n8mt7Fhc7",
  "currency": "EUR",
  "customer_details": {
    "billing_address": {
      "country": "US"
    },
    "id": "cus_7n42DGM5Tflk9n8mt7Fhc7"
  },
  "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
  "id": "inv_7n42DGM5Tflk9n8mt7Fhc7",
  "parent_invoice_id": "inv_7n42DGM5Tflk9n8mt7Fhc7",
  "subscription_id": "sub_7n42DGM5Tflk9n8mt7Fhc7",
  "transactions": [
    {
      "credit_note_id": "crn_7n42DGM5Tflk9n8mt7Fhc7",
      "id": "pay_7n42DGM5Tflk9n8mt7Fhc7",
      "parent_transaction_id": "pay_7n42DGM5Tflk9n8mt7Fhc7",
      "payment_method_id": "pm_7n42DGM5Tflk9n8mt7Fhc7"
    }
  ]
}

Changes