• Billing API

Invoices

get

Get an invoice by id

This handler get the invoice details based on the invoice ID

invoiceIdstring

required

invoiceId for which the details are supposed to be extracted

Responses

Response examples

Invoice Details based on the invoice ID

{
  "data": {
    "id": "string",
    "paymentProfileId": "string",
    "network": "string",
    "pdfUrl": "string",
    "status": "DRAFT",
    "totalPaymentAttempts": 123.0,
    "subTotal": 123.0,
    "taxTotal": 123.0,
    "currency": "string",
    "invoiceItems": [
      "string"
    ],
    "subscriptionItems": [
      {
        "id": "string",
        "network": "string",
        "total": 123.0,
        "currency": "string",
        "paymentProfileId": "string",
        "priceId": "string",
        "invoiceId": "string",
        "subscriptionId": "string",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "lastPaymentAttemptDate": "2023-06-07T17:32:28Z",
    "periodStart": "2023-06-07T17:32:28Z",
    "periodEnd": "2023-06-07T17:32:28Z",
    "createdAt": "2023-06-07T17:32:28Z"
  }
}
get

List all invoices

This endpoint retrieves a list of all invoices

limitstring

The maximum number of invoices to return (default 20, maximum 100)

Pattern
^[0-9][0-9]?$|^100$
startingAfterstring

The ID of the last invoice in the previous page of results. Results will start after this invoice

Responses

Response examples

A list of invoices

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "paymentProfileId": "string",
        "network": "string",
        "pdfUrl": "string",
        "status": "DRAFT",
        "totalPaymentAttempts": 123.0,
        "subTotal": 123.0,
        "taxTotal": 123.0,
        "currency": "string",
        "invoiceItems": [
          "string"
        ],
        "subscriptionItems": [
          {
            "id": "string",
            "network": "string",
            "total": 123.0,
            "currency": "string",
            "paymentProfileId": "string",
            "priceId": "string",
            "invoiceId": "string",
            "subscriptionId": "string",
            "description": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        ],
        "lastPaymentAttemptDate": "2023-06-07T17:32:28Z",
        "periodStart": "2023-06-07T17:32:28Z",
        "periodEnd": "2023-06-07T17:32:28Z",
        "createdAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}

Was this page helpful?