billing

GET /v1/billing/profile

Get the organization's billing profile.

billing အားလုံးသော အဆုံးသတ်များ

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပို့ပါ။ သော့တွင် billing.view ခွင့်ပြုချက် ပါရှိရမည်ဖြစ်ပြီး၊ ၎င်းမပါရှိသော သော့ကို 404 အစား 403 ဖြင့် ငြင်းပယ်ပါမည်။

သင့်အဖွဲ့အစည်း၏ id ထည့်သွင်းရမည့်နေရာ

ဤအစွန်အဖျား (endpoint) သည် org_id ကို မေးမြန်းချက် ကန့်သတ်ဘောင် (query parameter) အဖြစ် လက်ခံပါသည်။ ၎င်းကို ချန်လှပ်ထားပါက ခေါ်ဆိုမှုသည် သင်၏ ငှားရမ်းမှု လက်အောက်ခံသစ်ပင် (tenancy subtree) တစ်ခုလုံးကို လွှမ်းခြုံမည်ဖြစ်ပြီး၊ အဖွဲ့အစည်းတစ်ခုတည်းသို့ ကန့်သတ်ခေါ်ဆိုရန် ၎င်းကို ပေးပို့ပါ။

သင့်အဖွဲ့အစည်း id သည် သင်၏ ဒက်ရှ်ဘုတ်ရှိ API သော့များ မျက်နှာပြင်တွင်၊ သော့၏ ဘေး၌ ရှိပါသည်။ ၎င်းသည် သင်ပြုလုပ်သည့် ခေါ်ဆိုမှုတိုင်းတွင် တူညီသော id ဖြစ်ပါသည်။

စမ်းကြည့်ရန်

ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။

curl -X GET https://api.zinndigital.com/v1/billing/profile \
  -H "Authorization: Bearer zdk_live_…"

ဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို API ကွန်ဆိုးလ်တွင် ဖွင့်ပါ

အသေးစိတ်အချက်အလက်များ

Returns the customer's one "Bill to" block — what renders on the next invoice (docs/34 §2.5). An organization that has never saved one gets a **200 with an empty profile** (every field blank, `updated_at` null), not a 404, so the form always has a shape to render. Requires `billing.view`.

ကန့်သတ်ဘောင်များ

နာမည်အမျိုးအစားလိုအပ်သည်ဘာလဲဆိုတာ
org_id (query)Uuidမဟုတ်ပါThe organization whose profile to read; defaults to the caller's own.

တုံ့ပြန်ချက်

နာမည်အမျိုးအစားလိုအပ်သည်ဘာလဲဆိုတာ
org_idstringဟုတ်ကဲ့
legal_namestringဟုတ်ကဲ့
company_namestringဟုတ်ကဲ့
billing_addressBillingAddressဟုတ်ကဲ့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_numberstringဟုတ်ကဲ့
vat_statusstring<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_idLabelValueမဟုတ်ပါA free-label secondary tax id (US EIN, AU ABN, …). Null when unset.
custom_invoice_fieldsLabelValue[]ဟုတ်ကဲ့Up to five customer-defined `{label, value}` lines, rendered verbatim.
billing_emailstringဟုတ်ကဲ့Where invoices are delivered; blank means the account email.
invoice_localestringဟုတ်ကဲ့Preferred invoice language; blank means the account language.
updated_atstringမဟုတ်ပါWhen the profile was last saved. Null if it has never been saved.

ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ

401 · 403 · 422 · 429