InvoiceOut

Manage outgoing invoices, including creation, update, deletion, and advanced search.
Invoices can be linked to subscriptions, customers, and plans, and support metadata and filtering.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/invoice-out/index

Returns a paginated and filterable list of outgoing invoices.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching outgoing invoices

object

filter

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "customer_id": "cus-1",
    "invoice_out_year": 2024
  },
  "per-page": 10,
  "page": 1,
  "sort": "invoice_out_num"
}

Responses

200

List of outgoing invoices

Array<object>

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "invoice_out_id": "inv-1",
  "invoice_out_num": "2024-001",
  "invoice_out_year": 2024,
  "customer_id": "cus-1",
  "amount_invoice": 1000,
  "currency": "EUR",
  "payment_status": "paid"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

create

POST

/v2/invoice-out/create

Create a new outgoing invoice by providing the required details.

Request Body ^required

Invoice out object to be created

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "invoice_out_num": "2024-002",
  "invoice_out_year": 2024,
  "customer_id": "cus-2",
  "amount_invoice": 500,
  "currency": "EUR",
  "payment_status": "pending"
}

Responses

201

Invoice out created successfully

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "invoice_out_id": "inv-2",
  "invoice_out_num": "2024-002",
  "invoice_out_year": 2024,
  "customer_id": "cus-2",
  "amount_invoice": 500,
  "currency": "EUR",
  "payment_status": "pending"
}

view

GET

/v2/invoice-out/view/{id}

Retrieve an outgoing invoice by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the invoice out to retrieve

Responses

200

Invoice out found

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "invoice_out_id": "inv-1",
  "invoice_out_num": "2024-001",
  "invoice_out_year": 2024,
  "customer_id": "cus-1",
  "amount_invoice": 1000,
  "currency": "EUR",
  "payment_status": "paid"
}

404

Invoice out not found

delete

DELETE

/v2/invoice-out/delete/{id}

Delete an outgoing invoice by its unique ID.
If force=true, all related entities will also be deleted.

Path Parameters

id

required

string format: uuid

ID of the invoice out to delete

Query Parameters

force

boolean

Force the deletion of the entity and all related entities

Responses

204

Invoice out deleted successfully

400

If force=false, the operation is interrupted and the list of connected entities that will be deleted in case of confirmation (force=true) is returned

update

PUT

/v2/invoice-out/update/{id}

Update an existing outgoing invoice by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the invoice out to update

Request Body ^required

Invoice out object with updated data

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "payment_status": "paid"
}

Responses

200

Invoice out updated successfully

object

invoice_out_id

ID of the outgoing invoice

string

cb_invoice_num

Chargebee invoice number

string

invoice_out_num

Outgoing invoice number

string

invoice_out_year

Year of the outgoing invoice

integer

invoice_out_date

Date of the outgoing invoice

string format: date

subscription_id

ID of the subscription

string

customer_id

ID of the customer

string

customer_data

Customer data, or false if not available

string

nullable

plan_id

ID of the plan

string

item_data

Item data, or false if not available

string

nullable

amount_invoice

Total amount of the invoice

integer

amount_tax

Amount of tax on the invoice

integer

amount_paid

Amount paid towards the invoice

integer

payment_date

Date of the payment

string format: date

payment_status

Status of the payment

string

currency

Currency of the invoice

string

Example

{
  "invoice_out_id": "inv-1",
  "payment_status": "paid"
}

404

Invoice out not found