View as Markdown
SureCart icon

SureCart ACTION

Update Coupon

Update an existing coupon. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SureCart account once, then configure and run Update Coupon from your backend or agent.

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

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

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
surecart-update-coupon
Version
0.0.1
App
SureCart
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes