Refund an invoice

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this API request to refund an invoice for a customer. You can do a full or partial refund, up to the total amount of the invoice. If you want to sue the API to check the total refundable amount left on the invoice, you can use the Get Individual invoice API to get this information.

If the refund is successful, the API will return the amount left to refund on the invoice. If it was a partial refund this amount will show in unformatted amount, i.e. if the invoice amount is $10 and you refund 100, the total amount left to refund on the invoice will be $9.

Path Params
string
required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

string
required

The unique identifier of the customer in the Billsby platform

Body Params
string
required

The invoice number associated with the invoice you want to refund

int32
required

The amount you would like to refund (can be partial). Amounts are unformatted so if you're using a decimal currency, you'll need to put 100 to refund $1, for example.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain