billing

Mark billing invoice paid

Changed on
post/invoices/{invoice_id}/mark-paid

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/invoices/{invoice_id}/mark-paid
  • Auth
    API key in header X-Schematic-Api-Key

Path parameters

invoice_idstring required

invoice_id

Request body

amountinteger nullable

Amount paid, in minor units of the invoice's currency. Leave empty to mark the whole remaining amount as paid.

idempotency_keystring required

A retry with the same key records the payment once.

referencestring nullable

A note that identifies the payment, such as a bank transfer reference.

settled_atstring date-time nullable

When the payment arrived. Defaults to now, and cannot be in the future.

Response

OK

paramsobject required

Input parameters

Changes

  • 67a1a6df05feRevision changes
    • info

      added the optional property /// to the response with the status

  • 58d1145d1dddRevision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status