Invoices

For any call on this page, you are required to set the merchant using the Merchant Header.

Index

View a list of invoices for a merchant.

GET /billing/invoices

Example Response

{
    "invoices": [
        {
            "id": 1,
            "charger_id": "1",
            "charger_type": "company",
            "chargee_id": "1",
            "chargee_type": "team",
            "created_at": "2023-08-09T16:38:19.000000Z",
            "currency": "USD",
            "status": "Draft",
            "stripe_invoice_status": null,
            "stripe_invoice_id": null,
            "description": null,
            "total": 576.3
        }
    ]
}

Store

Create a new invoice for a list of charges.

POST /billing/invoices
Parameter Type Examples Description
charge_ids array<integer> [22] A list of IDs of the charges you would like to create an invoice for

Example Response

{
    "message": "Draft invoice created.",
    "invoice": {
        "id": 2,
        "charger_id": "1",
        "charger_type": "company",
        "chargee_id": "1",
        "chargee_type": "team",
        "created_at": "2023-08-09T16:39:26.558994Z",
        "currency": "USD",
        "status": "Draft",
        "stripe_invoice_status": null,
        "stripe_invoice_id": null,
        "description": null,
        "total": 293.8
    }
}