Checkout Utilities

These endpoints are called from your checkout UI before the subscriber completes their order. All are public (no auth required) unless noted.

Check email availability

POST /partner/checkout/check-email

Check whether an email address is available for a new subscriber account under a given provider.

Request body

{
  "email": "alice@example.com",
  "service_provider_document_id": "uuid"
}

Response

{
  "available": true
}

available: false means a subscriber account already exists for this email under the provider. Your checkout UI should prompt the subscriber to log in instead of creating a new account.

Check subscription at location

GET /partner/checkout/has-subscription-at-location

Check whether a subscriber is already active at a given location. Prevents duplicate subscriptions.

Query parameters

Parameter	Type	Description
`service_provider_document_id`	string	Your provider UUID
`location_hash`	string	10-char location hash

Response

{
  "has_subscription": false
}

has_subscription: true means the location already has an active subscription — your checkout UI should show an error or redirect.

Validate discount code

POST /partner/checkout/validate-discount-code

Validate a discount code and return its terms so you can display them in the checkout UI before applying.

Request body

{
  "discount_code": "SUMMER25",
  "service_provider_document_id": "uuid",
  "plan_version_id": "uuid"
}

Response — 200 OK (valid)

{
  "valid": true,
  "discount": {
    "id": "uuid",
    "code": "SUMMER25",
    "discount_type": "percentage | fixed",
    "amount": 25.0,
    "duration_months": 3,
    "description": "25% off for 3 months"
  }
}

Response — 200 OK (invalid)

{
  "valid": false,
  "reason": "expired | not_found | plan_not_eligible"
}

Pass the discount.id to the provisioning endpoint (discount_id field) after validation.

Overview

Plan Discovery

Provisioning

Reports

Subscribers & Subscriptions

AI Support Agent

Provider Operations (Internal API)

Checkout Utilities

Check email availability

Request body

Response

Check subscription at location

Query parameters

Response

Validate discount code

Request body

Response — 200 OK (valid)

Response — 200 OK (invalid)

​Check email availability

​Request body

​Response

​Check subscription at location

​Query parameters

​Response

​Validate discount code

​Request body

​Response — 200 OK (valid)

​Response — 200 OK (invalid)

Check email availability

Request body

Response

Check subscription at location

Query parameters

Response

Validate discount code

Request body

Response — 200 OK (valid)

Response — 200 OK (invalid)