v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Billing

Get Invoice

Get full details of an invoice and ay associated transactions

get/v1/billing/invoices/{invoice_id}

Path parameters

invoice_idinteger required

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": 880088,
    "date": "2024-05-21",
    "due_date": "2024-05-21",
    "payment": {
      "status": "Unpaid",
      "date_paid": "2024-05-21 11:13:10",
      "last_capture_attempt": "2024-05-21 11:13:10",
      "date_refunded": "2024-05-21 11:13:10",
      "date_cancelled": "2024-05-21 11:13:10",
      "payment_method": {
        "id": 880088,
        "type": "Credit Card",
        "active": true,
        "description": "Citi Platinum Business",
        "address": {
          "id": 42,
          "first_name": "Rocket",
          "last_name": "Billing-Contact",
          "address_line_1": "17885 SE Federal Hwy",
          "address_line_2": "Suite 100",
          "company_name": "Rocket.net",
          "email": "billing@rocket.net",
          "city": "Jupiter",
          "state": "FL",
          "country": "US",
          "postal_code": "33469",
          "telephone": "877-374-0764"
        },
        "address_id": 888000888,
        "card_last_four": "1234",
        "card_type": "Visa",
        "expiry_date": "04/29",
        "last_updated": "2024-01-01T02:00:00Z",
        "gateway_token": "pm_1Q56yCIpHZfwip1PT4nnaIMi"
      }
    },
    "subtotal": 30,
    "total": 30,
    "items": [
      {
        "type": "Hosting Plan",
        "product_or_addon_id": 1,
        "description": "Starter (05/21/2024 - 06/20/2024)",
        "amount": 30
      }
    ],
    "transactions": [
      {
        "id": "txn_3PIuNDIpHZfwip1P010HjTHA",
        "type": "Credit Card",
        "date": "2024-05-21 11:13:10",
        "amount": 30
      }
    ]
  }
}