1. Getting Started
CIAO API
  • Getting Started
    • Introduction
    • Authentication
    • Responses and Error
  • Partners
    • Webhooks
    • Redemption Intent (Partners)
      • Create Redemption Intent
      • Retrieve Redemption Intent
    • Subscriptions
      • Create Subscription
      • Retrieve a subscription
      • Cancel Subscription
  • Resellers
    • Webhooks
    • Voucher Generation (Resellers)
      • Create Voucher Payment
      • Retrieve Voucher Payment
  • General
    • Get all Counties
      GET
  1. Getting Started

Responses and Error

Responses & errors#

Success envelope#

{
  "status": true,
  "message": "Subscription created",
  "data": { }
}

Error envelope#

{
  "status": false,
  "message": "Human readable message",
  "error_code": "subscription_already_completed",
  "errors": {
    "email": ["The email field is required."]
  }
}
FieldWhen present
error_codeBusiness-rule failures
errorsValidation failures (422)
Important: Check error_code for business-rule failures (e.g. subscription_already_completed). Check errors for field validation failures (422).

HTTP statuses#

StatusMeaning
201Resource created
200Success
400Bad request
401Invalid or wrong-type API key
404Not found (scoped to your account + environment)
422Validation or business-rule error
429Rate limited
500Server error

Amounts#

Important: All amounts are integers in minor units (cents). 1000 = €10.00.

Versioning#

The API version is in the URL path: /api/v1. Future breaking changes will use a new prefix
(e.g. /api/v2).
Audience-specific error_code values are listed in Partners and
Resellers.
Modified at 2026-07-21 14:24:52
Previous
Authentication
Next
Partners
Built with