Commet
  • Pricing
Log InTry out
Create promo code POSTGet promo code GETList promo codes GETUpdate promo code PUT
DocumentationKnowledge BaseBuild with AIAPI ReferenceWebhooks

Update promo code

Update a promo code's redemption limits, expiration, active status, or plan restrictions.

List promo codes GET

List promo codes with cursor-based pagination.

Add seats POST

Add seats to a customer's subscription. Prorates charges for the current billing period.

PUT
/promo-codes/{id}

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

maxRedemptions?|
Range0 < value
expiresAt?|
Formatdate-time
active?boolean
planIds?array<>

Response Body

application/json

curl -X PUT "https://commet.co/api/v1/promo-codes/string" \  -H "Content-Type: application/json" \  -d '{}'

application/json

application/json

Update a promo code's redemption limits, expiration, active status, or plan restrictions.

Promo code public ID

{
  "success": true,
  "data": {
    "object": "promo_code",
    "livemode": true,
    "id": "string",
    "code": "string",
    "discountType": "percentage",
    "discountValue": 0,
    "durationCycles": 0,
    "maxRedemptions"







{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
{
  "success": false,
  "error": {
    "type": "validation_error",
    "code": "string",
    "message": "string",
    "doc_url": "string",
    "param": "string"
  }
}
:
0
,
"expiresAt": "2019-08-24T14:15:22Z",
"active": true,
"redemptionCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}