Create billing entity

POST

/v1/billing_entities/

Create a new billing entity.

Request Body ^required

BillingEntityCreate

object

code

required

Code

string

>= 1 characters <= 100 characters

name

required

Name

string

>= 1 characters <= 255 characters

legal_name

Any of:

string

string

<= 255 characters

null

null

address_line1

Any of:

string

string

null

null

address_line2

Any of:

string

string

null

null

city

Any of:

string

string

null

null

state

Any of:

string

string

null

null

country

Any of:

string

string

>= 2 characters <= 2 characters

null

null

zip_code

Any of:

string

string

null

null

tax_id

Any of:

string

string

null

null

email

Any of:

string

string format: email

null

null

currency

Currency

string

default: USD >= 3 characters <= 3 characters

timezone

Timezone

string

default: UTC <= 50 characters

document_locale

Document Locale

string

default: en <= 10 characters

invoice_prefix

Any of:

string

string

<= 20 characters

null

null

next_invoice_number

Next Invoice Number

integer

default: 1 >= 1

invoice_grace_period

Invoice Grace Period

integer

0

net_payment_term

Net Payment Term

integer

default: 30

invoice_footer

Any of:

string

string

<= 1024 characters

null

null

is_default

Is Default

boolean

Responses

201

Successful Response

BillingEntityResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

legal_name

required

Any of:

string

string

null

null

address_line1

required

Any of:

string

string

null

null

address_line2

required

Any of:

string

string

null

null

city

required

Any of:

string

string

null

null

state

required

Any of:

string

string

null

null

country

required

Any of:

string

string

null

null

zip_code

required

Any of:

string

string

null

null

tax_id

required

Any of:

string

string

null

null

email

required

Any of:

string

string

null

null

currency

required

Currency

string

timezone

required

Timezone

string

document_locale

required

Document Locale

string

invoice_prefix

required

Any of:

string

string

null

null

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

string

null

null

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

409

Billing entity with this code already exists

422

Validation error