List Billing Groups by Customer

GET

https://{{baseurl}}/customers/:customerUuid/billing-groups

GET

/customers/:customerUuid/billing-groups

curl https://{{baseurl}}/customers/45b0d09b-bc25-4b45-af21-dc15cba56ce2/billing-groups \
     -H "Authorization: Bearer <token>"

{
  "rows": [
    {
      "uuid": "ac9b0360-9b89-4608-9808-916f576fb173",
      "billingGroupName": "Australian BG",
      "billingGroupInvoiceName": "Acme Invoice",
      "billingGroupPrimaryEmail": "billing@acme.com",
      "billingGroupAdditionalEmailRecipients": "",
      "customerUuid": "45b0d09b-bc25-4b45-af21-dc15cba56ce2",
      "isDefaultBillingGroup": true
    },
    {
      "uuid": "7f3a1234-0000-4000-b000-000000000001",
      "billingGroupName": "NSW Projects",
      "billingGroupInvoiceName": "NSW Invoice",
      "billingGroupPrimaryEmail": "nsw@acme.com",
      "billingGroupAdditionalEmailRecipients": "",
      "customerUuid": "45b0d09b-bc25-4b45-af21-dc15cba56ce2",
      "isDefaultBillingGroup": false
    }
  ]
}

Returns all billing groups linked to the specified customer. Each row includes isDefaultBillingGroup to identify the default.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

customerUuidstringRequiredformat: "uuid"

UUID of the customer

Query parameters

searchstringOptional

Filter billing groups by name

Response

Successful Response

rowslist of objectsOptional

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors