billing
GET /v1/billing/profile
Get the organization's billing profile.
அங்கீகாரம்
பியரர் டோக்கனாக (bearer token) ஒரு API விசையை அனுப்பவும். அந்த விசை billing.view அனுமதியைக் கொண்டிருக்க வேண்டும்; அது இல்லாத விசை 404 அல்ல, 403 குறியீட்டுடன் மறுக்கப்படும்.
உங்கள் அமைப்பு ஐடி எங்கு செல்ல வேண்டும்
இந்த எண்ட் பாயிண்ட் org_id என்பதை வினவல் அளபுருவாக (query parameter) எடுத்துக்கொள்கிறது. இதை விட்டுவிட்டால், அழைப்பு உங்கள் முழு டெனன்சி துணை மரத்தையும் (tenancy subtree) உள்ளடக்கும்; ஒரு நிறுவனத்திற்கு மட்டுமே அழைப்பைக் சுருக்க இதை அனுப்பவும்.
உங்கள் நிறுவன ஐடி உங்கள் டாஷ்போர்டில் உள்ள API விசைகள் திரையில், விசைக்கு அருகிலேயே உள்ளது. நீங்கள் செய்யும் ஒவ்வொரு அழைப்பிலும் இதுவே ஒரே ஐடி ஆகும்.
முயன்று பார்
கோண அடைப்புக்குறிகளில் உள்ள எதையும் உங்கள் சொந்த மதிப்புகளுடன் மாற்றவும், மேலும் விசை பிளேஸ்ஹோல்டரை உங்கள் டாஷ்போர்டில் உள்ள விசையுடன் மாற்றவும்.
curl -X GET https://api.zinndigital.com/v1/billing/profile \
-H "Authorization: Bearer zdk_live_…"உள்நுழைந்துள்ளீர்களா? உங்கள் டேஷ்போர்டில் உள்ள ஏபிஐ கன்சோல் உங்கள் உண்மையான நிறுவன ஐடி மற்றும் உங்கள் சொந்த சாவியை நிரப்புகிறது, மேலும் நேரலை ஏபிஐக்கு எதிராக கோரிக்கையை இயக்குகிறது, இதனால் நீங்கள் உண்மையான பதிலைக் காண முடியும். இந்த எண்ட்மார்க்கை ஏபிஐ கன்சோலில் திறக்கவும்
விவரங்கள்
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_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