/v1/profile/contract

Overview

Retrieves the rendered contract HTML and related metadata for a specific purchase on a client profile.

This endpoint is typically used to display a contract to the client for review and signature before or after completing a purchase.

Method: GET
Path: /v1/profile/contract

Authentication

This request requires authentication.

Uses the TOKEN variable in the request (e.g. as a bearer or API token) to authorize access.

Ensure {{TOKEN}} is set in the active environment before sending the request.

Query Parameters

The following query parameters are required to identify the correct contract instance:

id_region (integer)

Numeric identifier of the regional context for the business (e.g., region or deployment shard).

k_business (integer)

Unique key of the WellnessLiving business (business ID).

k_location (integer)

Unique key of the specific location (studio/branch) where the purchase/contract is associated.

uid (integer or string)

Unique identifier of the client/profile whose contract is being retrieved.

id_purchase_item (integer)

Indicates the type/category of purchase item (e.g., membership, pass, class/event, etc.).

k_id (integer)

Unique key of the specific purchase item instance for which the contract is generated.

All of these parameters must be provided together to return the correct contract.

Successful Response (200 OK)

On success, the response body includes:

html_contract (string)

HTML fragment containing the contract content to render in a browser or web view (e.g. terms, conditions, signature block).

i_minor_age (integer)

Age threshold that defines a “minor” for this contract (e.g., 18). Can be used to determine if a guardian signature is required.

text_title (string)

Human-readable contract title or template name (e.g., "Copy 4 of CLASS/EVENTS MEMBERSHIP").

status (string)

Request status flag, typically "ok" on success.

s_version (string)

Internal contract/template version string, useful for auditing or debugging.

__a_message (array of strings)

Internal messages or flags related to this contract instance (may be used for promotions, durations, or other contract metadata).

Example (truncated):

{
  "html_contract": "<div class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>\n<p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>A BB please sign</p>\n</div><comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>...<truncated>",
  "i_minor_age": 18,
  "text_title": "Copy 4 of CLASS/EVENTS MEMBERSHIP",
  "status": "ok",
  "s_version": "444085",
  "__a_message": [
    "month|rs.promotion;a.duration.sid"
  ]
}

Typical Usage

Display the contract in a client-facing UI by rendering the html_contract field.

Check status is "ok" before showing the contract.

Use text_title, s_version, and __a_message to label, track, or troubleshoot the specific contract configuration returned.

Overview#

Authentication#

Query Parameters#

Successful Response (200 OK)#

Typical Usage#

Request

Responses

Overview

Authentication

Query Parameters

Successful Response (200 OK)

Typical Usage