Billing Holds API

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

Endpoint Index

ActionEndpoint
Fetch HoldGET /billing/{tenantLocator}/holds/{locator}
Fetch All Holds for an AccountGET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list
Add HoldPOST /billing/{tenantLocator}/holds
Patch HoldPATCH /billing/{tenantLocator}/holds/{locator}
Validate HoldPATCH /billing/{tenantLocator}/holds/{locator}/validate
Activate HoldPATCH /billing/{tenantLocator}/holds/{locator}/activate
Release HoldPATCH /billing/{tenantLocator}/holds/{locator}/release
Reset HoldPATCH /billing/{tenantLocator}/holds/{locator}/reset
Discard HoldPATCH /billing/{tenantLocator}/holds/{locator}/discard

Fetch

Fetch Hold
fetchHold
GET /billing/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathstringrequired
    statequeryEnum? draft | validated | active | discarded | releasedoptional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Response:HoldListResponse
    Security Group:holds   Permissions:read,list

Creation and Update

Add Hold
addHold
POST /billing/{tenantLocator}/holds
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
HoldCreateRequest
required
accountLocator string
targetType Enum invoicing | delinquency
Patch Hold
patchHold
PATCH /billing/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:HoldResponse
    Security Group:holds   Permission:write
Activate Hold
activateHold
PATCH /billing/{tenantLocator}/holds/{locator}/activate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:HoldResponse
    Security Group:holds   Permission:write

Release, Reset, and Discard

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

See Also