Quick Start Guide

Before you start

To complete this guide, the caller needs:

• An FTT account.
• A case UUID belonging to that account.

API keys must adhere to strict handling rules:

• Never be shared in chat or support tickets.
• Be stored in a secret manager.
• Be transmitted only in the Authorization bearer header.

Get a credential

API keys are generated and managed in the dashboard at API Keys.

To create a credential:

1. Sign in.
2. Open the API Keys page.
3. Enter a key name.
4. Select the required scopes.
5. Choose an expiry date.
6. Create the key.

Verified key management behavior:

• The default expiry is 90 days.
• The raw key is displayed once.
• It must be copied and stored securely.
• It can be revoked from the same page.

We recommend beginning with status:read only.

Environment

• HTTPS is required.
• The base URL is https://api.freetrialterminator.com.
• The status endpoint is /api/status/{case_id} and is not under /api/v1.
• All snippets must display full URLs assembled from API_ORIGIN.

Step 1 – Check status

To check the status of an existing cancellation case, send an authenticated GET request:

curl -X GET "https://api.freetrialterminator.com/api/status/<CASE_ID>" \
  -H "Authorization: Bearer $FTT_API_KEY" \
  -H "X-Request-Id: $(uuidgen)"

const response = await fetch(`https://api.freetrialterminator.com/api/status/<CASE_ID>`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer $FTT_API_KEY',
    'X-Request-Id': crypto.randomUUID(),
  },
});
const status = await response.json();

A verified end-to-end request and response example will be published separately in E15B-04.

Step 2 – Request execution

To request cancellation execution for an owned case, use the bodyless execution endpoint:

• POST https://api.freetrialterminator.com/api/status/<CASE_ID>/execute
• Authorization required.
• Idempotency-Key required.
• X-Request-Id optional.
• No request body.
• No Content-Type header.

curl -X POST "https://api.freetrialterminator.com/api/status/<CASE_ID>/execute" \
  -H "Authorization: Bearer $FTT_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "X-Request-Id: $(uuidgen)"

const response = await fetch(`https://api.freetrialterminator.com/api/status/<CASE_ID>/execute`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer $FTT_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'X-Request-Id': crypto.randomUUID(),
  },
});
const result = await response.json();

Execution rules and idempotency:

• A non-empty request body is invalid.
• Generate one idempotency key for one execution intent.
• Reuse that same key when retrying the same intent.
• Use a new key only for a genuinely new execution intent.
• HTTP 200 alone does not prove provider-side completion.
• Callers must inspect current_state and completion_confirmed.
• Only current_state: CONFIRMED represents completed cancellation.

This bodyless requirement supersedes the stale body example from the older Week 15A document.

Supported workflow and states

Approved workflow tiers:

• GUIDE: unauthenticated general guidance with no case access.
• ASSIST: reads canonical status after verified binding.
• INITIATE: reads status and requests explicit confirmation without changing state.
• EXECUTE: submits the canonical execution request with an idempotency key.

ASSIST, INITIATE, and EXECUTE require an FTT-issued HTTPS handoff link valid for no more than 15 minutes.

Passwords and API keys must never be pasted into chat.

Canonical execution states:

CREATEDDETECTEDSCHEDULEDINITIATEDACTION_REQUIREDIN_PROGRESSCONFIRMEDCANCELLEDNO_CANCELLATION_REQUIREDFAILEDDLQINTERRUPTED

• Only CONFIRMED maps to completed cancellation.
• ACTION_REQUIRED is non-terminal.
• When ACTION_REQUIRED is returned, its next_action must be shown to the user.

The channel adapter is staging and experimental. Production channel wiring is unsupported.

Provider limitations

• FTT execution is separate from provider-controlled completion.
• Some providers require customer action.
• Telephone-contact cancellation flows are unsupported.

Errors

Retryable errors are 429 RATE_LIMITED and 503 SERVICE_UNAVAILABLE.

HTTP 403 represents an authorization or required-scope failure.

Next resources

• Security & Privacy
• OpenAPI 3.1

Questions: api@freetrialterminator.com