Billing Holds API
Billing Holds are used to temporarily suspend invoicing and delinquency processes including lapse.
Fetch
GET /billing/{tenantLocator}/holds/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:read
HoldResponse
¶requiredlocator locatoraccountLocator locatorholdState Enum draft | validated | active | discarded | releasedtargetType Enum invoicing | delinquencyupdatedAt datetimecreatedAt datetimeoptionalvalidationResult ValidationResult?
GET /billing/{tenantLocator}/holds/accounts/{accountLocator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
accountLocator | path | locator | 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
¶requiredlistCompleted booleanitems HoldResponse[]
Creation and Update
POST /billing/{tenantLocator}/holds
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:HoldCreateRequest
Response:HoldResponse
Security Group:holds  Permission:write
HoldCreateRequest
¶requiredaccountLocator locatortargetType Enum invoicing | delinquency
PATCH /billing/{tenantLocator}/holds/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:HoldUpdateRequest
Response:HoldResponse
Security Group:holds  Permission:write
HoldUpdateRequest
¶optionalaccountLocator locator?targetType Enum? invoicing | delinquency
Execution
PATCH /billing/{tenantLocator}/holds/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:write
PATCH /billing/{tenantLocator}/holds/{locator}/activate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:write
Release, Reset, and Discard
PATCH /billing/{tenantLocator}/holds/{locator}/release
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:write
PATCH /billing/{tenantLocator}/holds/{locator}/reset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:write
PATCH /billing/{tenantLocator}/holds/{locator}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:HoldResponse
Security Group:holds  Permission:write