RevKeenDocs

Set or clear a cart discount code

Set the cart's discount code. Pass null to clear. The code is stored only — discount pricing math has not shipped yet. Convert blocks with CART_SESSION_DISCOUNT_PENDING while a code is set.

Related endpoints

  • POST /cart-sessions — Create a cart session
  • GET /cart-sessions/{id} — Retrieve a cart session
  • POST /cart-sessions/{id}/line-items — Add a line item to a cart session
  • PATCH /cart-sessions/{id}/line-items/{lineId} — Update a line item's quantity
  • DELETE /cart-sessions/{id}/line-items/{lineId} — Remove a line item from a cart session
  • POST /cart-sessions/{id}/add-ons — Toggle an add-on on a cart session
  • POST /cart-sessions/{id}/convert — Convert a cart session into a checkout session

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 unauthenticated — missing, malformed, or revoked API key.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.
  • 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

POST
/cart-sessions/{id}/discount-code

Authorization

x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.revkeen.com/v2/cart-sessions/550e8400-e29b-41d4-a716-446655440000/discount-code" \  -H "x-api-key: $REVKEEN_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "code": "SAVE10"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "object": "cart_session",
    "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
    "currency": "str",
    "mode": "payment",
    "status": "open",
    "line_items": [
      {
        "id": "cli_550e8400-e29b-41d4-a716-446655440000",
        "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
        "name": "string",
        "quantity": 0,
        "unit_price_minor": 0,
        "currency": "str",
        "recurring": {
          "interval": "month",
          "interval_count": 1
        },
        "metadata": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "add_ons_offered": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "add_ons_selected": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "discount_code": "string",
    "subtotal_minor": 0,
    "total_minor": 0,
    "metadata": {
      "property1": null,
      "property2": null
    },
    "converted_to_checkout_session_id": "5d37f263-6519-4765-9535-e6aa5913d87c",
    "public_token": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "Cart session not found",
  "code": "CART_SESSION_NOT_FOUND"
}
{
  "error": "string"
}
{
  "error": "Cart session not found",
  "code": "CART_SESSION_NOT_FOUND"
}
{
  "error": "Cart session not found",
  "code": "CART_SESSION_NOT_FOUND"
}
Edit on GitHub

Add a line item to a cart session

Previous Page

Convert a cart session into a checkout session

Next Page