billing

PUT /v1/billing/profile

Replace the organization's billing profile.

Tüm billing uç noktaları

Tüm geliştirici belgeleri

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar billing.invoice.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

AdTürZorunluNe olduğu
org_id (query)UuidHayırThe organization whose profile to replace; defaults to the caller's own.

İstek gövdesi

AdTürZorunluNe olduğu
legal_namestringHayır
company_namestringHayır
billing_addressBillingAddressEvetA 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_numberstringHayır
tax_idLabelValueHayır
custom_invoice_fieldsLabelValue[]Hayır
billing_emailstringHayır
invoice_localestringHayır

Yanıt

AdTürZorunluNe olduğu
org_idstringEvet
legal_namestringEvet
company_namestringEvet
billing_addressBillingAddressEvetA 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_numberstringEvet
vat_statusstring<unvalidated, pending, valid, invalid>EvetState 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_idLabelValueHayırA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]EvetUp to five customer-defined {label, value} lines, rendered verbatim.
billing_emailstringEvetWhere invoices are delivered; blank means the account email.
invoice_localestringEvetPreferred invoice language; blank means the account language.
updated_atstringHayırWhen the profile was last saved. Null if it has never been saved.

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 422 · 429