# Update Coupon — SureCart

> Update an existing coupon. See the documentation

- Key: `surecart-update-coupon`
- Type: Action (Write)
- Version: 0.0.1
- App: SureCart (`surecart`) — https://pipedream.com/apps/surecart.md
- This page (HTML): https://pipedream.com/apps/surecart/actions/update-coupon
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/surecart/actions/update-coupon/update-coupon.mjs

## Description

Update an existing coupon. [See the documentation](https://developer.surecart.com/api-reference/coupons/update)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `couponId` | `string` | Yes | The unique identifier of the coupon. Use List Coupons to retrieve a list of available coupons. |
| `name` | `string` | No | The coupon name. Example: Summer Sale |
| `amountOff` | `integer` | No | Amount off the subtotal, in cents. Provide either this or Percent Off. Example: 500 for $5.00 |
| `percentOff` | `integer` | No | Percentage off the subtotal. Provide either this or Amount Off. Example: 10 |
| `duration` | `string` | No | How long the discount applies to subscriptions. Defaults to once. |
| `durationInMonths` | `integer` | No | If Duration is repeating, the number of months the coupon applies. Example: 3 |
| `maxRedemptions` | `integer` | No | Max total redemptions across all customers. |
| `maxRedemptionsPerCustomer` | `integer` | No | Max redemptions per customer. |
| `maxSubtotalAmount` | `integer` | No | Max checkout subtotal in cents for the coupon to apply. |
| `minSubtotalAmount` | `integer` | No | Min checkout subtotal in cents required for the coupon to apply. |
| `productIds` | `string[]` | No | Restrict the coupon to specific product UUIDs. Use List Products to find product IDs. |
| `redeemBy` | `integer` | No | Unix timestamp after which the coupon can no longer be redeemed. Example: 1735689600 |
| `archived` | `boolean` | No | Set to true to archive the coupon. |
| `metadata` | `object` | No | Additional key-value metadata. Example: { "internal_id": "123" } |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "surecart",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "surecart-update-coupon",
  arguments: {
    couponId: "Coupon ID",
    name: "Name",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "surecart-update-coupon",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    couponId: "Coupon ID",
    name: "Name",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "surecart-update-coupon",
    "configured_props": {
      "surecart": { "authProvisionId": "apn_xxxxxxx" },
      "couponId": "Coupon ID",
      "name": "Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/surecart.md · All apps: https://pipedream.com/apps