Bulk add invoice line items - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Path Params

id

string

required

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

lines

array [object {7}]

required

A list of items to be added to a draft invoice (up to 250 items per invoice)

amount

integer

optional

Amount (in the currency specified) of the invoice item. This should always be equal to unit_amount * quantity.

currency

string

optional

Three-letter ISO currency code

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

price

string

optional

The ID of the price object. One of price or price_data is required.

quantity

integer

optional

The quantity of the subscription, if the line item is a subscription or a proration.

unit_amount

integer

optional

The integer unit amount in pence of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. Passing in a negative unit_amount will reduce the amount_due on the invoice.

Example

{
  "lines": [
    {
      "amount": 0,
      "currency": "string",
      "description": "string",
      "metadata": {},
      "price": "string",
      "quantity": 0,
      "unit_amount": 0
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://apitest.wooshpay.com/v1/invoices//add_lines?members&reference&Type&_postman_listIndexKey=key&_postman_listAllowsMultipleValues' \
--data-raw ''

Responses

🟢200Success

application/json

Body

object {0}

Example

{}