billing

PUT `/v1/billing/profile`

Replace the organization's billing profile.

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास billing.invoice.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

जहां आपकी संगठन आईडी आती है

यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।

आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें

विवरण

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.

पैरामीटर

नाम	प्रकार	आवश्यक	यह क्या है
`org_id (query)`	`Uuid`	नहीं	The organization whose profile to replace; defaults to the caller's own.

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`legal_name`	`string`	नहीं	—
`company_name`	`string`	नहीं	—
`billing_address`	`BillingAddress`	हाँ	A 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_number`	`string`	नहीं	—
`tax_id`	`LabelValue`	नहीं	—
`custom_invoice_fields`	`LabelValue[]`	नहीं	—
`billing_email`	`string`	नहीं	—
`invoice_locale`	`string`	नहीं	—

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`org_id`	`string`	हाँ	—
`legal_name`	`string`	हाँ	—
`company_name`	`string`	हाँ	—
`billing_address`	`BillingAddress`	हाँ	A 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_number`	`string`	हाँ	—
`vat_status`	`string<unvalidated, pending, valid, invalid>`	हाँ	State 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_id`	`LabelValue`	नहीं	A free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
`custom_invoice_fields`	`LabelValue[]`	हाँ	Up to five customer-defined `{label, value}` lines, rendered verbatim.
`billing_email`	`string`	हाँ	Where invoices are delivered; blank means the account email.
`invoice_locale`	`string`	हाँ	Preferred invoice language; blank means the account language.
`updated_at`	`string`	नहीं	When the profile was last saved. Null if it has never been saved.

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 422 · 429

PUT /v1/billing/profile