Billing Holds API

Billing Holds are used to temporarily suspend invoicing and delinquency processes including lapse.

Endpoint Index

Action	Endpoint
Fetch Hold	GET /billing/{tenantLocator}/holds/{locator}
Fetch All Holds for an Account	GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list
Create Hold	POST /billing/{tenantLocator}/holds
Update Hold	PATCH /billing/{tenantLocator}/holds/{locator}
Validate Hold	PATCH /billing/{tenantLocator}/holds/{locator}/validate
Activate Hold	PATCH /billing/{tenantLocator}/holds/{locator}/activate
Release Hold	PATCH /billing/{tenantLocator}/holds/{locator}/release
Reset Hold	PATCH /billing/{tenantLocator}/holds/{locator}/reset
Discard Hold	PATCH /billing/{tenantLocator}/holds/{locator}/discard

Fetch

Fetch Hold

fetchHold

GET /billing/{tenantLocator}/holds/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:read

HoldResponse

required
locator string
accountLocator string
holdState Enum draft | validated | active | discarded | released
targetType Enum invoicing | delinquency
updatedAt datetime
createdAt datetime

optional
validationResult ValidationResult?

Fetch All Holds for an Account

fetchAllHoldsForAnAccount

GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
state	query	Enum? draft | validated | active | discarded | released	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:HoldListResponse
Security Group:holds   Permissions:read,list

HoldListResponse

required
listCompleted boolean
items HoldResponse[]

Creation and Update

Create Hold

createHold

POST /billing/{tenantLocator}/holds

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:HoldCreateRequest
Response:HoldResponse
Security Group:holds   Permission:write

HoldCreateRequest

required
accountLocator string
targetType Enum invoicing | delinquency

Update Hold

updateHold

PATCH /billing/{tenantLocator}/holds/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:HoldUpdateRequest
Response:HoldResponse
Security Group:holds   Permission:write

HoldUpdateRequest

optional
accountLocator string?
targetType Enum? invoicing | delinquency

Execution

Validate Hold

validateHold

PATCH /billing/{tenantLocator}/holds/{locator}/validate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:write

Activate Hold

activateHold

PATCH /billing/{tenantLocator}/holds/{locator}/activate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:write

Release, Reset, and Discard

Release Hold

releaseHold

PATCH /billing/{tenantLocator}/holds/{locator}/release

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:write

Reset Hold

resetHold

PATCH /billing/{tenantLocator}/holds/{locator}/reset

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:write

Discard Hold

discardHold

PATCH /billing/{tenantLocator}/holds/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:HoldResponse
Security Group:holds   Permission:write

See Also

• Billing Holds Feature Guide