PApaypal
Invoices

Get all invoices

get/invoices

Request

Query parameters

per_pageinteger

Number of records per page

pageinteger

Page number

status'DRAFT' | 'FINALIZED' nullable

Status of the invoice

Example:FINALIZED

Filter invoices by status

payment_status'PENDING' | 'FAILED' | 'SUCCEEDED'

Filter invoices by payment status (e.g., pending, failed, succeeded)

external_customer_idstring

Filter invoices by external customer ID

issuing_date_fromstring date required

Date in ISO 8601 format (YYYY-MM-DD).

Example:2023-10-01

Filter invoices issued on or after this date (ISO 8601 format)

issuing_date_tostring date required

Date in ISO 8601 format (YYYY-MM-DD).

Example:2023-10-01

Filter invoices issued on or before this date (ISO 8601 format)

Response

A list of invoices.

Example response

{
  "invoices": [
    {
      "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
      "billing_entity_code": "acme_inc",
      "sequential_id": 3,
      "status": "FINALIZED",
      "payment_status": "PENDING",
      "amount": {
        "total_amount": {
          "value": 120.35,
          "currency_code": "USD"
        },
        "breakdown": {
          "fees": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "credit_notes": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "sub_total_excluding_taxes": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "taxes": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "sub_total_including_taxes": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "prepaid_credit": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "progressive_billing_credit": {
            "value": 120.35,
            "currency_code": "USD"
          }
        }
      },
      "fees": [
        {
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "total_amount": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "name": "Basic Plan"
        }
      ],
      "due_date": "2023-10-01",
      "issued_date": "2023-10-01",
      "invoice_number": "INV-2023-001",
      "version_number": "INV-2023-001",
      "invoice_type": "SUBSCRIPTION",
      "customer": {
        "name": "John Doe",
        "external_id": "ext_cust_12345",
        "email": "abc@test.com",
        "billing_entity_code": "acme_inc",
        "address": {
          "line1": "123 Main St",
          "line2": "Apt 4B",
          "city": "New York",
          "state": "NY",
          "postal_code": "10001",
          "country": "US"
        },
        "phone": "+1-234-567-8900",
        "payment_method_token": "pm_visa_4242",
        "payment_method_type": "CARD",
        "taxes": [
          {
            "name": "TVA",
            "rate": "20.00",
            "description": "French standard VAT",
            "code": "standard_vat",
            "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
            "created_at": "2025-06-01T00:00:00Z"
          }
        ],
        "metadata": [
          {
            "key": "Purchase Order",
            "value": "123456789",
            "display_in_invoice": true
          }
        ]
      },
      "billing_period": [
        {
          "subscription_id": "sub_01H3YT8P7Q5R3S1T2U0V4W9X8",
          "external_subscription_id": "ext_id_23fw3",
          "plan_id": "plan_01H3YT8P7Q5R3S1T2U0V4W9X8",
          "payment_method_token": "pm_visa_4242",
          "payment_method_type": "CARD",
          "subscription_from_datetime": "2023-10-01T12:00:00Z",
          "subscription_to_datetime": "2023-10-01T12:00:00Z",
          "charges_from_datetime": "2023-10-01T12:00:00Z",
          "charges_to_datetime": "2023-10-01T12:00:00Z",
          "invoicing_reason": "subscription"
        }
      ],
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z",
      "applied_taxes": [
        {
          "id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "tax_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
          "tax_name": "TVA",
          "tax_code": "french_standard_vat",
          "tax_rate": 20,
          "tax_description": "French standard VAT",
          "amount": {
            "value": 120.35,
            "currency_code": "USD"
          },
          "created_at": "2023-10-01T12:00:00Z",
          "fees_amount": {
            "value": 120.35
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.