billing

PUT /v1/billing/profile

Replace the organization's billing profile.

Semua titik akhir billing

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin billing.invoice.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Titik akhir ini menerima org_id sebagai parameter kueri. Kosongkan parameter tersebut dan panggilan ini akan mencakup seluruh subpohon penyewa Anda; kirimkan untuk mempersempit panggilan ke satu organisasi.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

curl -X PUT https://api.zinndigital.com/v1/billing/profile \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "billing_address": <BillingAddress> }'

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

A full replace (PUT) of the editable "Bill to" fields; an omitted field resets to blank. `billing_address` (with its required `country`, needed for tax) is the one mandatory member. Editing changes only invoices issued **afterwards** — a past invoice snapshotted the buyer block at issue time and is never rewritten (docs/34 §1.1). `vat_status` is engine-owned (the validate-not-trust flow, §2.3) and is not accepted here; changing `vat_number` resets it to `unvalidated`. Requires `billing.invoice.manage` in the target organization.

Parameter

NamaJenisWajibTentang apa ini
org_id (query)UuidTidakThe organization whose profile to replace; defaults to the caller's own.

Isi permintaan

NamaJenisWajibTentang apa ini
legal_namestringTidak
company_namestringTidak
billing_addressBillingAddressYaA billing address. Everything is optional **except** `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server.
vat_numberstringTidak
tax_idLabelValueTidak
custom_invoice_fieldsLabelValue[]Tidak
billing_emailstringTidak
invoice_localestringTidak

Tanggapan

NamaJenisWajibTentang apa ini
org_idstringYa
legal_namestringYa
company_namestringYa
billing_addressBillingAddressYaA billing address. Everything is optional **except** `country`, which tax determination needs (docs/34 §2.2). `country` is an ISO 3166-1 alpha-2 code, uppercased by the server.
vat_numberstringYa
vat_statusstring<unvalidated, pending, valid, invalid>YaState of the validate-not-trust check on `vat_number` (docs/34 §2.3). Read-only; a change to `vat_number` resets it to `unvalidated`.
tax_idLabelValueTidakA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]YaUp to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringYaWhere invoices are delivered; blank means the account email.
invoice_localestringYaPreferred invoice language; blank means the account language.
updated_atstringTidakWhen the profile was last saved. Null if it has never been saved.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429