Skip to content

Update billing entity

PATCH

/v1/billing_entities/{code}

Update a billing entity by code.

Parameters

Path Parameters

code

required

Code

string

Request Body^required

BillingEntityUpdate

object

name

Any of:

string
null

string

>= 1 characters <= 255 characters

legal_name

Any of:

string
null

string

<= 255 characters

address_line1

Any of:

string
null

string

address_line2

Any of:

string
null

string

city

Any of:

string
null

string

state

Any of:

string
null

string

country

Any of:

string
null

string

>= 2 characters <= 2 characters

zip_code

Any of:

string
null

string

tax_id

Any of:

string
null

string

email

Any of:

string
null

string format: email

currency

Any of:

string
null

string

>= 3 characters <= 3 characters

timezone

Any of:

string
null

string

<= 50 characters

document_locale

Any of:

string
null

string

<= 10 characters

invoice_prefix

Any of:

string
null

string

<= 20 characters

next_invoice_number

Any of:

integer
null

integer

>= 1

invoice_grace_period

Any of:

integer
null

integer

net_payment_term

Any of:

integer
null

integer

invoice_footer

Any of:

string
null

string

<= 1024 characters

is_default

Any of:

boolean
null

boolean

Responses

200

Successful Response

BillingEntityResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

legal_name

required

Any of:

string
null

string

address_line1

required

Any of:

string
null

string

address_line2

required

Any of:

string
null

string

city

required

Any of:

string
null

string

state

required

Any of:

string
null

string

country

required

Any of:

string
null

string

zip_code

required

Any of:

string
null

string

tax_id

required

Any of:

string
null

string

email

required

Any of:

string
null

string

currency

required

Currency

string

timezone

required

Timezone

string

document_locale

required

Document Locale

string

invoice_prefix

required

Any of:

string
null

string

next_invoice_number

required

Next Invoice Number

integer

invoice_grace_period

required

Invoice Grace Period

integer

net_payment_term

required

Net Payment Term

integer

invoice_footer

required

Any of:

string
null

string

is_default

required

Is Default

boolean

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized – invalid or missing API key

404

Billing entity not found

422

Validation error