Skip to main content
PUT
/
api
/
public
/
billing
/
coworkerContracts
/
v2
/
{contractId}
/
resume
{
  "400 Bad Request": {},
  "401 Unauthorized": {},
  "404 Not Found": {}
}

​
Resume Contract

Resumes a previously paused plan contract. Supports two modes: immediate resumption (effective today) or resumption at the natural end of the current pause period.

​
Authentication

This endpoint requires an authenticated customer session.

​
Path Parameters

​
contractId
number
required
The unique identifier of the contract to resume.

​
Query Parameters

​
immediate
boolean
required
When true, the contract is resumed immediately. When false, the contract will resume at the end of its current scheduled pause period.

​
Request Body

No request body is required.

​
Response

A successful response returns an empty body or a generic confirmation. No typed response object is defined for this endpoint.

​
Usage in Portal

Called when the customer clicks the resume button in the My Plans section.
  • File: src/views/user/plans/useMyPlansData.ts

​
Typical integration pattern

// From src/api/endpoints.ts
// endpoints.billing.contracts.resume = (contractId: number, immediate: boolean) => ({
//   url: `/api/public/billing/coworkerContracts/v2/${contractId}/resume?immediate=${immediate}`,
// })

// Resume immediately
const resumeNow = async (contractId: number) => {
  return httpClient.put(endpoints.billing.contracts.resume(contractId, true).url, {})
}

// Resume at end of pause period
const resumeAtEnd = async (contractId: number) => {
  return httpClient.put(endpoints.billing.contracts.resume(contractId, false).url, {})
}
  • GET /api/public/billing/coworkerContracts/{contractId} – Get contract details including pause state
  • GET /api/public/billing/coworkerContracts/{contractId}/pause/meta – Get pause eligibility metadata
  • PUT /api/public/billing/coworkerContracts/v2/{contractId}/pause – Pause a contract

​
Error Responses

​
400 Bad Request
error
The contract is not currently paused or cannot be resumed. The response body contains an error code.
​
401 Unauthorized
error
The current user is not authenticated or does not have access to this contract.
​
404 Not Found
error
Contract with the specified ID does not exist.