Skip to content
Oclavex is in private preview, available to selected users. Public signup is blocked. Request access at [email protected].

A customer changed: creates or updates the Organization with the same reference.

POST
/api/v1/provision/admin/billing-events/account-changed
curl --request POST \
--url https://example.com/api/v1/provision/admin/billing-events/account-changed \
--header 'Content-Type: application/json' \
--data '{ "externalReference": "example", "changeType": "Created", "name": "example", "email": "example", "webUrl": "example", "phoneNumber": "example", "address": "example", "city": "example", "country": "example", "companyInfo": "example", "isDeleted": true, "legalName": "example", "addressLine2": "example", "postalCode": "example", "stateOrProvince": "example", "vatNumber": "example", "taxIdScheme": "example", "taxId": "example", "billingDetailsOnly": true }'

A customer as your billing system sees it, applied to the Organization with the same reference.

object
externalReference

The customer, e.g. chargebee:customer:16BQ....

string
changeType
Allowed values: Created Updated Deleted Undeleted
name
string
email
null | string
webUrl
null | string
phoneNumber
null | string
address

The billing address’s first line.

null | string
city
null | string
country
null | string
companyInfo
null | string
isDeleted
boolean
legalName
null | string
addressLine2
null | string
postalCode
null | string
stateOrProvince
null | string
vatNumber
null | string
taxIdScheme
null | string
taxId
null | string
billingDetailsOnly

Your system owns only the invoice details: an existing Organization keeps its name, contact fields and existence, and none is created for a reference no Organization carries.

boolean

Accepted

The event was accepted and published; its consumer applies it shortly after.

object
eventId
required
string format: uuid

Bad Request

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Unauthorized

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string

Forbidden

object
type
null | string
title
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
detail
null | string
instance
null | string