Billing Holds API

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

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

Fetch HoldfetchHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

read

HoldResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`holdState`	`Enum draft \| validated \| active \| discarded \| released`
`targetType`	`Enum invoicing \| delinquency`
`updatedAt`	`datetime`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`

Fetch All Holds For An Account

Fetch All Holds For An AccountfetchAllHoldsForAnAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`state`	query	`Enum? draft \| validated \| active \| discarded \| released`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:HoldListResponse

Security Group:holds

Permissions:

read,list

HoldListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`HoldResponse[]`

Creation and Update

Create Hold

Create HoldcreateHold

POST/billing/{tenantLocator}/holds

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:HoldCreateRequest

Response:HoldResponse

Security Group:holds

Permission:

write

HoldCreateRequest

Required properties

Property	Type	Description
`accountLocator`	`ulid`
`targetType`	`Enum invoicing \| delinquency`

Update Hold

Update HoldupdateHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:HoldUpdateRequest

Response:HoldResponse

Security Group:holds

Permission:

write

HoldUpdateRequest

Properties

Property	Type	Description
`accountLocator`	`ulid?`
`targetType`	`Enum? invoicing \| delinquency`

Execution

Validate Hold

Validate HoldvalidateHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

write

Activate Hold

Activate HoldactivateHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

write

Release, Reset, and Discard

Release Hold

Release HoldreleaseHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

write

Reset Hold

Reset HoldresetHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

write

Discard Hold

Discard HolddiscardHold

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:HoldResponse

Security Group:holds

Permission:

write

Billing Holds API

Fetch

Fetch Hold

Fetch All Holds For An Account

Creation and Update

Create Hold

Update Hold

Execution

Validate Hold

Activate Hold

Release, Reset, and Discard

Release Hold

Reset Hold

Discard Hold

See Also

On this page