OpenapiMarketing
Returns the caller org's OWN redemption of a promo — an org-scoped read, so it…
Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's.
GET /v1/marketing/promos/{code}/redemption
| Address | https://api.hanzo.ai/v1/marketing/promos/{code}/redemption |
| Method | GET |
| Operation | get_marketing_promos_by_code_redemption |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the caller org's OWN redemption of a promo — an org-scoped read, so it can never surface another tenant's. Not found when this org has not redeemed it.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
code | path | string | yes | Code is the promo code from the path, e.g. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | Redemption | ok |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
code | body | string | — | Code is the promo redeemed. |
discountCents | body | integer | — | DiscountCents is the month-one discount this redemption CLAIMS, in USD cents. It is a recorded figure, NOT a balance: nothing was credited and no wallet moved. |
plan | body | string | — | Plan is the tier redeemed against: pro, max or team. |
redeemedAt | body | integer | — | RedeemedAt is unix seconds. |
seats | body | integer | — | Seats is the seat count the claim was priced at, and it is ALWAYS 1. |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing promos redemption <code>import { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingPromosByCodeRedemption({ code: 'code' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_promos_by_code_redemption(code='code')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingPromosByCodeRedemption(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, marketing_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = marketing_api::get_marketing_promos_by_code_redemption(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MarketingApi(client).getMarketingPromosByCodeRedemption();curl https://api.hanzo.ai/v1/marketing/promos/<code>/redemption \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_marketing_audiences"
}
}
}'How is this guide?