❮❮ Back to Samples

Request Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com"
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": 100,
            "unit_price": {
                "currency": "USD",
                "value": "5"
            }
        },
        {
            "name": "Injection",
            "quantity": 5,
            "unit_price": {
                "currency": "USD",
                "value": "5"
            }
        }
    ]
}

Response Object

{
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com"
        }
    ],
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-05-21 PDT"
    },
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": 100,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        },
        {
            "name": "Injection",
            "quantity": 5,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        }
    ],
    "id": "INV2-ZKYE-ST2T-6KTY-ZWBT",
    "number": "INV-20180727205957",
    "template_id": "TEMP-2951065150453822S",
    "status": "DRAFT",
    "invoice_date": "2025-04-06 PDT",
    "total_amount": {
        "currency": "USD",
        "value": "525.00"
    },
    "metadata": {
        "created_date": "2025-04-06 00:23:02 PDT"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT",
            "method": "GET"
        },
        {
            "rel": "send",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/send",
            "method": "POST"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/update",
            "method": "PUT"
        },
        {
            "rel": "delete",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT",
            "method": "DELETE"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/record-payment",
            "method": "POST"
        }
    ]
}

Request Object

Response Object

Request Object

INV2-ZKYE-ST2T-6KTY-ZWBT

Response Object

{
    "id": "INV2-ZKYE-ST2T-6KTY-ZWBT",
    "number": "INV-20180727205957",
    "template_id": "TEMP-2951065150453822S",
    "status": "SENT",
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com"
        }
    ],
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": 100,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        },
        {
            "name": "Injection",
            "quantity": 5,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        }
    ],
    "invoice_date": "2025-04-06 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-05-21 PDT"
    },
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "total_amount": {
        "currency": "USD",
        "value": "525.00"
    },
    "metadata": {
        "created_date": "2025-04-06 00:23:02 PDT",
        "first_sent_date": "2025-04-06 00:23:03 PDT",
        "last_sent_date": "2025-04-06 00:23:03 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-ZKYE-ST2T-6KTY-ZWBT"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/qr-code",
            "method": "GET"
        }
    ]
}

Request Object

{
    "subject": "Past due",
    "note": "Please pay soon",
    "send_to_merchant": true
}

Response Object

Request Object

INV2-ZKYE-ST2T-6KTY-ZWBT

Response Object

{
    "id": "INV2-ZKYE-ST2T-6KTY-ZWBT",
    "number": "INV-20180727205957",
    "template_id": "TEMP-2951065150453822S",
    "status": "SENT",
    "merchant_info": {
        "email": "jaypatel512-facilitator@hotmail.com",
        "first_name": "Dennis",
        "last_name": "Doctor",
        "business_name": "Medical Professionals, LLC",
        "phone": {
            "country_code": "001",
            "national_number": "5032141716"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "billing_info": [
        {
            "email": "example@example.com"
        }
    ],
    "shipping_info": {
        "first_name": "Sally",
        "last_name": "Patient",
        "business_name": "Not applicable",
        "phone": {
            "country_code": "001",
            "national_number": "5039871234"
        },
        "address": {
            "line1": "1234 Main St.",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97217",
            "country_code": "US"
        }
    },
    "items": [
        {
            "name": "Sutures",
            "quantity": 100,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        },
        {
            "name": "Injection",
            "quantity": 5,
            "unit_price": {
                "currency": "USD",
                "value": "5.00"
            }
        }
    ],
    "invoice_date": "2025-04-06 PDT",
    "payment_term": {
        "term_type": "NET_45",
        "due_date": "2025-05-21 PDT"
    },
    "note": "Medical Invoice 16 Jul, 2013 PST",
    "total_amount": {
        "currency": "USD",
        "value": "525.00"
    },
    "metadata": {
        "created_date": "2025-04-06 00:23:02 PDT",
        "first_sent_date": "2025-04-06 00:23:03 PDT",
        "last_sent_date": "2025-04-06 00:23:03 PDT",
        "payer_view_url": "https://www.sandbox.paypal.com/invoice/p/#INV2-ZKYE-ST2T-6KTY-ZWBT"
    },
    "links": [
        {
            "rel": "self",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT",
            "method": "GET"
        },
        {
            "rel": "replace",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/update",
            "method": "PUT"
        },
        {
            "rel": "cancel",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/cancel",
            "method": "POST"
        },
        {
            "rel": "remind",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/remind",
            "method": "POST"
        },
        {
            "rel": "record-payment",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/record-payment",
            "method": "POST"
        },
        {
            "rel": "qr-code",
            "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZKYE-ST2T-6KTY-ZWBT/qr-code",
            "method": "GET"
        }
    ]
}