cURL
curl --request POST \
--url https://commet.co/api/v1/offers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"phases": [
{
"type": "percentage",
"durationCycles": 4503599627370495,
"percentage": 5000
}
]
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const offer = await commet.offers.create({
name: "example",
phases: [
{
type: "percentage",
durationCycles: 3,
percentage: 2000,
},
],
});from commet import Commet
commet = Commet("ck_xxx")
offer = commet.offers.create(
name="example",
phases=[{"type": "percentage", "duration_cycles": 3, "percentage": 2000}],
)client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
durationCycles := 3
offer, err := client.Offers.Create(ctx, &commet.CreateOfferParams{
Name: "example",
Phases: []commet.CreateOfferParamsPhasesItem{{Value: commet.CreateOfferParamsPhasesItemVariant1{
Type: "percentage",
DurationCycles: &durationCycles,
Percentage: 2000,
}}},
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.models.CreateOfferParamsPhasesItemVariant1;
import co.commet.params.CreateOfferParams;
import java.util.List;
var commet = Commet.builder().apiKey("ck_xxx").build();
var offer = commet.offers().create(
CreateOfferParams.builder("example", List.of(new CreateOfferParamsPhasesItemVariant1("percentage", 3L, null, 2000L))).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$offer = $commet->offers->create(
name: 'example',
phases: [['type' => 'percentage', 'duration_cycles' => 3, 'percentage' => 2000]],
);{
"id": "offer_1a2b3c4d",
"name": "Launch discount",
"phases": [
{
"type": "percentage",
"durationCycles": 3,
"durationInterval": "monthly",
"percentage": 20
}
],
"metadata": {},
"startsAt": null,
"endsAt": null,
"active": true,
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"object": "offer",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Offers
Create offer
Create reusable offer terms without assigning a plan, price, eligibility rule, or distribution channel.
POST
/
offers
cURL
curl --request POST \
--url https://commet.co/api/v1/offers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"phases": [
{
"type": "percentage",
"durationCycles": 4503599627370495,
"percentage": 5000
}
]
}
'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const offer = await commet.offers.create({
name: "example",
phases: [
{
type: "percentage",
durationCycles: 3,
percentage: 2000,
},
],
});from commet import Commet
commet = Commet("ck_xxx")
offer = commet.offers.create(
name="example",
phases=[{"type": "percentage", "duration_cycles": 3, "percentage": 2000}],
)client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
durationCycles := 3
offer, err := client.Offers.Create(ctx, &commet.CreateOfferParams{
Name: "example",
Phases: []commet.CreateOfferParamsPhasesItem{{Value: commet.CreateOfferParamsPhasesItemVariant1{
Type: "percentage",
DurationCycles: &durationCycles,
Percentage: 2000,
}}},
})
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.models.CreateOfferParamsPhasesItemVariant1;
import co.commet.params.CreateOfferParams;
import java.util.List;
var commet = Commet.builder().apiKey("ck_xxx").build();
var offer = commet.offers().create(
CreateOfferParams.builder("example", List.of(new CreateOfferParamsPhasesItemVariant1("percentage", 3L, null, 2000L))).build()
);use Commet\Commet;
$commet = new Commet('ck_xxx');
$offer = $commet->offers->create(
name: 'example',
phases: [['type' => 'percentage', 'duration_cycles' => 3, 'percentage' => 2000]],
);{
"id": "offer_1a2b3c4d",
"name": "Launch discount",
"phases": [
{
"type": "percentage",
"durationCycles": 3,
"durationInterval": "monthly",
"percentage": 20
}
],
"metadata": {},
"startsAt": null,
"endsAt": null,
"active": true,
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"object": "offer",
"livemode": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "not_found_error",
"code": "not_found",
"message": "The requested resource was not found.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/not_found.md"
}
}{
"error": {
"type": "conflict_error",
"code": "idempotency_in_progress",
"message": "A request with this idempotency key is still being processed.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_in_progress.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}{
"error": {
"type": "internal_error",
"code": "idempotency_unavailable",
"message": "Idempotency storage is temporarily unavailable. Retry with the same idempotency key.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/idempotency_unavailable.md"
}
}Create reusable offer terms without assigning a plan, price, eligibility rule, or distribution channel.
Headers
Body
application/json
Response
Success
Was this page helpful?