Get billing profile for settings page

GET/v1/settings/billing/profile

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

address_line_1stringrequired

address_line_2stringrequired

billing_emailstringrequired

billing_phonestringrequired

citystringrequired

completebooleanrequired

completenessSettingsBillingProfileCompletenessItemrequired

Show properties

is_completebooleanrequired

missing_fieldsstring[] | nullrequired

country_codestringrequired

created_atstring

last_updated_atstring

last_updated_bystring

legal_namestringrequired

missing_fieldsstring[] | nullrequired

organization_idstringrequired

postal_codestringrequired

state_or_provincestringrequired

tax_idstringrequired

tax_namestringrequired

updated_atstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/settings/billing/profile"

const response = await fetch("/v1/settings/billing/profile", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/settings/billing/profile",
)

Response

{
  "address_line_1": "string",
  "address_line_2": "string",
  "billing_email": "string",
  "billing_phone": "string",
  "city": "string",
  "complete": true,
  "completeness": {
    "is_complete": true,
    "missing_fields": [
      "string"
    ]
  },
  "country_code": "string",
  "created_at": "string",
  "last_updated_at": "string",
  "last_updated_by": "string",
  "legal_name": "string",
  "missing_fields": [
    "string"
  ],
  "organization_id": "string",
  "postal_code": "string",
  "state_or_province": "string",
  "tax_id": "string",
  "tax_name": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}