Update the billing account

Changes your billing data (JSON Merge Patch). mode, paymentTermsDays, voidedRedemptionsBillable and preferredPaymentMethodType are set by AllRide (400 data-failed-validation with item admin-only-field): AllRide decides whether you pay by SEPA Direct Debit or by bank transfer. Changing vatId or address.country resets vatIdStatus to unverified and starts a VIES check. The account status is re-derived in the same transaction. Allowed while your partner is suspended, so you can fix billing data. See the billing guide.

Required permissions: manage-consumer-billing · API keys: not allowed · Recent sign-in: required for dashboard users (15 minutes)

PATCH /consumer/v1/billing/account

cURL

po-and-language

curl --request PATCH \
  --url https://api.voucher-staging.allride.io/consumer/v1/billing/account \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchaseOrderReference": "PO-2026-17",
  "invoiceLanguage": "en"
}
'

200

default

{
  "data": {
    "id": 30017,
    "resource": "billing-account",
    "status": "active",
    "mode": "invoiced",
    "legalName": "Example Transit GmbH",
    "address": {
      "line1": "Musterstraße 1",
      "line2": null,
      "postalCode": "70173",
      "city": "Stuttgart",
      "region": null,
      "country": "DE"
    },
    "vatId": "DE123456789",
    "vatIdStatus": "valid",
    "vatIdCheckedAt": "2026-10-22T09:05:00Z",
    "taxTreatment": "domestic",
    "buyerReference": null,
    "purchaseOrderReference": "PO-2026-17",
    "invoiceLanguage": "de",
    "paymentTermsDays": 14,
    "preferredPaymentMethodType": "sepa-debit",
    "defaultPaymentMethodId": 42017,
    "eInvoiceFormat": "zugferd-en16931",
    "creditBalance": {
      "value": 0,
      "label": "€0.00"
    },
    "standing": "good-standing",
    "missingItems": [],
    "bankTransferInstructions": {
      "iban": "DE00 0000 0000 0000 0000 00",
      "bic": "EXAMPLEXXX",
      "accountHolderName": "AllRide GmbH",
      "bankName": "Example Bank"
    },
    "createdAt": "2026-10-22T09:00:00Z",
    "updatedAt": "2026-11-02T08:10:00Z",
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/billing/account",
        "type": "application/json"
      },
      "invoices": {
        "href": "https://api.voucher.allride.io/consumer/v1/billing/invoices",
        "type": "application/json"
      }
    }
  }
}

Dashboard session only. API keys cannot call this operation.

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Body

application/json

JSON Merge Patch of your billing account: absent = unchanged, null = clear. mode, paymentTermsDays, voidedRedemptionsBillable and preferredPaymentMethodType are set by AllRide (400 data-failed-validation with item admin-only-field).

legalName · string

Legal name.

Required string length: 1 - 200

address · object

Address fields to change.

Show child attributes

vatId · string | null

VAT ID; null clears it.

Pattern: ^[A-Z]{2}[0-9A-Z+*.]{2,12}$

buyerReference · string | null

Buyer reference (Leitweg-ID).

Maximum string length: 200

purchaseOrderReference · string | null

Purchase order reference.

Maximum string length: 100

invoiceLanguage · enum<string>

Invoice language.

Available options: de, en

eInvoiceFormat · enum<string>

E-invoice format. Treat as an open set: new values may be added.

Available options: zugferd-en16931, xrechnung-cii

Response

200

application/json

OK

Single-object envelope around a BillingAccount.

data · object · required

Your billing account (consumer view). One per consumer partner, created automatically.

Show child attributes