v1

latestOpenAPI 3.0.12026-07-24310590875.6 KB

invoices

Get invoice payment link

Get an invoice payment link. In the response, BILL sends you a payment link based on the provided invoice and customer information.

You can send the invoice payment link to your customer for getting paid by the customer. With this link, the customer can complete the invoice payment without the need to set up a BILL account.

When a customer payment is made with the invoice payment link, BILL sends a payment receipt to the provided email address.

Note: You get valid invoice payment links only for customers that are NOT connected with your organization in the BILL network.

See Invoices in the Guides section for more information, sample requests, and responses.

post/v3/invoices/{invoiceId}/payment-link

Path parameters

invoiceIdstring required

BILL-generated ID of the invoice. The value begins with 00e.

Example:{{invoice_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}

devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Request body

customerIdstring required

BILL-generated ID of the customer. The value begins with 0cu.

emailstring required

Recipient email address.

When a customer payment is made with the invoice payment link, BILL sends a payment receipt to the provided email address.

returnUrlstring

Redirect URL after the customer payment is complete

Example request

{
  "customerId": "{{customer_id}}",
  "email": "{{customer_email}}"
}

Response

Get an invoice payment link response

paymentLinkstring

Invoice payment link