v1

latestSwagger 2.02026-08-04232286653.5 KB

Entities

Update details for an organization that the logged in user owns.

A successful response from this resource will contain the updated organization details.

put/organizations/entities

Query parameters

org_idstring required

Request body

company_namestring

organization_namestring

tax_idstring

tax_id_type'EIN' | 'VAT'

Example request

{
  "billing_addr": {
    "address_line1": "123 Main Street",
    "address_line2": "Suite 400",
    "city": "Denver",
    "country": "US",
    "postal_code": "80202",
    "state_or_region": "Colorado"
  },
  "company_name": "mycompany",
  "organization_name": "Crusoe Energy",
  "tax_id": "51-2144346"
}

Response

Example response

{
  "entity": {
    "billing": {
      "balance": "$1000.00",
      "has_valid_payment_method": true
    },
    "billing_addr": {
      "address_line1": "123 Main Street",
      "address_line2": "Suite 400",
      "city": "Denver",
      "country": "US",
      "postal_code": "80202",
      "state_or_region": "Colorado"
    },
    "company_name": "mycompany",
    "id": "ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab",
    "mfa_methods": [
      {
        "created_at": "2021-12-03T19:58:34Z"
      }
    ],
    "name": "Crusoe Energy",
    "registration_type": "waitlist",
    "relation": "owner",
    "tax_id": "51-2144346"
  }
}