API reference | Billing accounts

Method	Path	Summary
PATCH	/billing-accounts/{billingAccountId}	Update a billing account

Every endpoint needs billing-accounts:write.

The BillingAccount object

firestoreIdstringrequired

ID of the billing account.

typestringrequired

Kind of holder of the billing account.

individual
The billing account belongs to a person, described in individual.
organization
The billing account belongs to an organization, described in organization.

ownerstringrequired

individualobject

Show 5 child fields

firstNamestringrequired

lastNamestringrequired

emailstringemailrequired

phonestringrequired

addressPostalAddress

Postal address, with the parts of an ISO 20022 postal address.

Show 12 child fields

countrystringrequired

ISO 3166-1 alpha-2 country code

postCodestringrequired

Post code of the address.

townNamestringrequired

Name of the town or city.

streetNamestring

Name of the street.

buildingNumberstring

Number of the building in the street.

namestring

Name of the building or place.

sortingCodestring

Additional sorting code of the postal service, used in a few countries such as France.

postBoxstring

Post office box.

administrativeAreastring

Region of the country, such as a canton or a state.

recipientsstring[]

Names of the people the address is for.

organizationstring

Name of the organization at the address.

sourcestring[]

Text the address was read from, one item per line.

organizationobject

Show 6 child fields

namestringrequired

emailstringemailrequired

phonestring

addressPostalAddress

Postal address, with the parts of an ISO 20022 postal address.

Show 12 child fields

countrystringrequired

ISO 3166-1 alpha-2 country code

postCodestringrequired

Post code of the address.

townNamestringrequired

Name of the town or city.

streetNamestring

Name of the street.

buildingNumberstring

Number of the building in the street.

namestring

Name of the building or place.

sortingCodestring

Additional sorting code of the postal service, used in a few countries such as France.

postBoxstring

Post office box.

administrativeAreastring

Region of the country, such as a canton or a state.

recipientsstring[]

Names of the people the address is for.

organizationstring

Name of the organization at the address.

sourcestring[]

Text the address was read from, one item per line.

contactobjectrequired

Show 4 child fields

firstNamestring

lastNamestring

emailstringemailrequired

phonestring

metadataobjectrequired

Show 3 child fields

foundationDatestring

sizestring

Number of employees of the company.

lessFive
Fewer than 5 employees.
fiveToTen
5 to 10 employees.
elevenToFifty
11 to 50 employees.
fiftyOneToOneHundred
51 to 100 employees.
oneHundredToTwoHundredFifty
100 to 250 employees.
moreThanTwoHundredFifty
More than 250 employees.

industrystring

Industry of the company.

Show 29 values

agriculturePisciculture
Agriculture and fish farming.
businessServices
Business services.
chemical
Chemical industry.
commerce
Commerce.
communication
Communication.
construction
Construction.
cultureEntertainment
Culture and entertainment.
defense
Defense.
education
Education.
energy
Energy.
finance
Finance.
food
Food.
forestry
Forestry.
health
Health.
hospitalityCatering
Hospitality and catering.
insurance
Insurance.
legal
Legal services.
manufacturing
Manufacturing.
mediaInformation
Media and information.
miningOilGas
Mining, oil and gas.
personalServices
Personal services.
publicService
Public service.
realEstate
Real estate.
sportFitness
Sport and fitness.
technology
Technology.
textileLifeStyle
Textile and lifestyle.
tourism
Tourism.
transportation
Transportation.
other
Another industry.

workspaceIdsstring[]required

creationobjectrequired

When and by whom the resource was created.

Show 2 child fields

creationDateTimestringdate-timerequired

Date and time when the resource was created.

createdBystring

ID of the user who created the resource, when recorded.

Show all 8 fields

activationobjectrequired

Whether the resource is enabled, and when and by whom it was last enabled or disabled.

Show 3 child fields

enabledbooleanrequired

Whether the resource is enabled.

updateDateTimestringdate-timerequired

Date and time when enabled was last set.

updatedBystring

ID of the user who last set enabled, when recorded.

The BillingAccount object

{
  "firestoreId": "Bl6tW3mQ8xKp2vNr7zHs",
  "type": "individual",
  "owner": "string",
  "individual": {
    "firstName": "string",
    "lastName": "string",
    "email": "anna.meier@example.com",
    "phone": "+41791234567",
    "address": {
      "country": "CH",
      "postCode": "8001",
      "townName": "Zürich",
      "streetName": "Bahnhofstrasse",
      "buildingNumber": "10",
      "name": "Haus zur Linde",
      "sortingCode": "string",
      "postBox": "Postfach 1234",
      "administrativeArea": "Zürich",
      "recipients": [
        "Anna Meier"
      ],
      "organization": "Muster AG",
      "source": [
        "Muster AG",
        "Bahnhofstrasse 10",
        "8001 Zürich"
      ]
    }
  },
  "organization": {
    "name": "string",
    "email": "anna.meier@example.com",
    "phone": "+41791234567",
    "address": {
      "country": "CH",
      "postCode": "8001",
      "townName": "Zürich",
      "streetName": "Bahnhofstrasse",
      "buildingNumber": "10",
      "name": "Haus zur Linde",
      "sortingCode": "string",
      "postBox": "Postfach 1234",
      "administrativeArea": "Zürich",
      "recipients": [
        "Anna Meier"
      ],
      "organization": "Muster AG",
      "source": [
        "Muster AG",
        "Bahnhofstrasse 10",
        "8001 Zürich"
      ]
    },
    "contact": {
      "firstName": "string",
      "lastName": "string",
      "email": "anna.meier@example.com",
      "phone": "+41791234567"
    },
    "metadata": {
      "foundationDate": "1990-05-14",
      "size": "lessFive",
      "industry": "agriculturePisciculture"
    }
  },
  "workspaceIds": [
    "string"
  ],
  "creation": {
    "creationDateTime": "2026-03-02T09:15:00.000Z",
    "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  },
  "activation": {
    "enabled": true,
    "updateDateTime": "2026-03-02T09:15:00.000Z",
    "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
  }
}

PATCH/billing-accounts/{billingAccountId}

Update a billing account

Scopebilling-accounts:write

Path parameters

billingAccountIdstringrequired

ID of the billing account.

Query parameters

fieldsstring

Comma-separated property paths to include in the response, or in each item of a list. Use dots for nested paths.

Request body

addressPostalAddressrequired

Postal address, with the parts of an ISO 20022 postal address.

Show 12 child fields

countrystringrequired

ISO 3166-1 alpha-2 country code

postCodestringrequired

Post code of the address.

townNamestringrequired

Name of the town or city.

streetNamestring

Name of the street.

buildingNumberstring

Number of the building in the street.

namestring

Name of the building or place.

sortingCodestring

Additional sorting code of the postal service, used in a few countries such as France.

postBoxstring

Post office box.

administrativeAreastring

Region of the country, such as a canton or a state.

recipientsstring[]

Names of the people the address is for.

organizationstring

Name of the organization at the address.

sourcestring[]

Text the address was read from, one item per line.

Returns

200

Successful response

dataBillingAccountrequired

curl -X PATCH 'https://api.business.swayapp.io/v1/billing-accounts/Bl6tW3mQ8xKp2vNr7zHs' \
  -H "Authorization: Bearer $SWAY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "address": {
    "country": "CH",
    "postCode": "8001",
    "townName": "Zürich",
    "streetName": "Bahnhofstrasse",
    "buildingNumber": "10",
    "name": "Haus zur Linde",
    "postBox": "Postfach 1234",
    "administrativeArea": "Zürich",
    "recipients": [
      "Anna Meier"
    ],
    "organization": "Muster AG",
    "source": [
      "Muster AG",
      "Bahnhofstrasse 10",
      "8001 Zürich"
    ]
  }
}'

const response = await fetch('https://api.business.swayapp.io/v1/billing-accounts/Bl6tW3mQ8xKp2vNr7zHs', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.SWAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "address": {
      "country": "CH",
      "postCode": "8001",
      "townName": "Zürich",
      "streetName": "Bahnhofstrasse",
      "buildingNumber": "10",
      "name": "Haus zur Linde",
      "postBox": "Postfach 1234",
      "administrativeArea": "Zürich",
      "recipients": [
        "Anna Meier"
      ],
      "organization": "Muster AG",
      "source": [
        "Muster AG",
        "Bahnhofstrasse 10",
        "8001 Zürich"
      ]
    }
  }),
});
console.log(await response.json());

import os

import requests

response = requests.patch(
    "https://api.business.swayapp.io/v1/billing-accounts/Bl6tW3mQ8xKp2vNr7zHs",
    headers={"Authorization": f"Bearer {os.environ['SWAY_API_KEY']}"},
    json={
        "address": {
            "country": "CH",
            "postCode": "8001",
            "townName": "Zürich",
            "streetName": "Bahnhofstrasse",
            "buildingNumber": "10",
            "name": "Haus zur Linde",
            "postBox": "Postfach 1234",
            "administrativeArea": "Zürich",
            "recipients": [
                "Anna Meier",
            ],
            "organization": "Muster AG",
            "source": [
                "Muster AG",
                "Bahnhofstrasse 10",
                "8001 Zürich",
            ],
        },
    },
)
print(response.json())

{
  "data": {
    "firestoreId": "Bl6tW3mQ8xKp2vNr7zHs",
    "type": "individual",
    "owner": "string",
    "individual": {…},
    "organization": {…},
    "workspaceIds": [
      "string"
    ],
    "creation": {
      "creationDateTime": "2026-03-02T09:15:00.000Z",
      "createdBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    },
    "activation": {
      "enabled": true,
      "updateDateTime": "2026-03-02T09:15:00.000Z",
      "updatedBy": "Xq3vT9mB2kLpR7sN4wYc8dZf1aHj"
    }
  }
}

{
  "error": {
    "code": "invalid-argument",
    "message": "Invalid request"
  }
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or expired credentials"
  }
}

{
  "error": {
    "code": "permission-denied",
    "message": "Missing required scope: invoices:read"
  }
}

{
  "error": {
    "code": "not-found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Cookies, with your consent

Billing accounts

The BillingAccount object

Update a billing account

Path parameters

Query parameters

Request body

Returns

Start building on your own data.