Billing Holds API

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

Fetch

Fetch Hold
fetchHold
GET /billing/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:read
HoldResponse
required
locator locator
accountLocator locator
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathlocatorrequired
    statequeryEnum? draft | validated | active | discarded | releasedoptional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:holds   Permissions:read,list
HoldListResponse
required
listCompleted boolean
items HoldResponse[]

Creation and Update

Create Hold
createHold
POST /billing/{tenantLocator}/holds
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
HoldCreateRequest
required
accountLocator locator
targetType Enum invoicing | delinquency
Update Hold
updateHold
PATCH /billing/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
HoldUpdateRequest
optional
accountLocator locator?
targetType Enum? invoicing | delinquency

Execution

Validate Hold
validateHold
PATCH /billing/{tenantLocator}/holds/{locator}/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
Activate Hold
activateHold
PATCH /billing/{tenantLocator}/holds/{locator}/activate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write

Release, Reset, and Discard

Release Hold
releaseHold
PATCH /billing/{tenantLocator}/holds/{locator}/release
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
Reset Hold
resetHold
PATCH /billing/{tenantLocator}/holds/{locator}/reset
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
Discard Hold
discardHold
PATCH /billing/{tenantLocator}/holds/{locator}/discard
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Response:HoldResponse
    Security Group:holds   Permission:write

See Also