SamCart

App · 25 actions

Work with your SamCart store: find orders, charges, refunds, failed payments, customers and abandoned checkouts, refund charges, cancel, pause, restart and discount subscriptions, and create products and coupons. Start workflows on new orders, payments, refunds, failed payments, subscriptions and cancellations.

Actions

ActionWhat it does
Apply coupon to subscriptionDiscount an active or delinquent subscription's future payments with a coupon that applies to every payment.
Cancel subscriptionCancel a subscription now, replacing any cancellation scheduled for later.
Change next payment dateMove an active or delinquent subscription's next payment to another time in the future.
Create couponCreate a coupon code: a percentage or fixed amount off, on the first payment or every payment, for every product or chosen ones.
Create productCreate a one-time or subscription product, live and in your marketplace's currency, with SamCart's default settings.
Get chargeGet one charge: what was captured, for which order and subscription, and whether it was refunded.
Get customerGet one customer with every address on file and their saved payment methods.
Get orderGet one order with its customer, addresses, payment method, checkout custom field answers and every product with its price, charge and subscription.
Get productGet one product with its description, price, checkout link, tags and whether coupons apply.
Get subscriptionGet one subscription with what each payment charges, its coupon, any scheduled cancellation, what it has collected, failed payments and the customer.
List abandoned checkoutsList prospects: people who entered their details on a checkout but didn't buy, once per product, filtered by email, product or date.
List chargesList successful charges (first payments and subscription rebills) with their amount and refund status, filtered by order, customer, subscription, type, status or date.
List couponsList coupons with their code, discount and limits, filtered by code, product, archived or date.
List customersList customers with their contact details, tags and SMS consent, filtered by email, phone or date.
List failed chargesList payment attempts that failed (at checkout or on a subscription rebill) with the processor's reason, filtered by order, customer, subscription, payment method or date.
List ordersList orders with their totals, status, customer and products, filtered by customer, email, status, product, coupon code or date.
List productsList products with their price, pricing type, checkout link and whether they are archived or in test mode, filtered by archived, category, pricing type, SKU or date.
List refundsList refunds with their amount and the charge, order and customer they belong to, filtered by order, charge, customer or date.
List subscriptionsList subscriptions with their product, price, status, customer and next payment, filtered by customer, product, order, status, type, a pending cancellation, or when they next bill, ended or started.
Refund chargeRefund a charge through its payment processor, in full or in part.
Remove scheduled cancellationTake back a cancellation scheduled for later, so the subscription keeps billing.
Restart subscriptionRestart a canceled or delinquent subscription so it bills again, such as after the customer updates their card.
Schedule subscription cancellationSet an active subscription to cancel at the end of its billing period or on a date.
Update order custom fieldsChange the answers to an order's checkout custom fields, by each field's slug (as 'Get order' shows them under custom_fields).
Update productChange a product's name, internal name, SKU, description, search engine title and description, link name or one-time price, archive or restore it, or switch it between test mode and live.

Apply coupon to subscription

Discount an active or delinquent subscription's future payments with a coupon that applies to every payment. It replaces any coupon the subscription has; coupons don't stack.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.
Couponcoupon_idtextRequired
A coupon set to apply to every payment, for all products or this subscription's product.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": {
      "charge_instance": "recurring",
      "code": "STAY20",
      "discount_amount": null,
      "discount_percentage": 20,
      "id": "01J4X6ZCPNQ3W9GJ4X6Z0V8Q3D",
      "type": "percentage"
    },
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1599,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1599,
      "taxes": 0,
      "total": 1599
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Cancel subscription

Cancel a subscription now, replacing any cancellation scheduled for later. Works on active, delinquent and paused subscriptions. To pause one, cancel it without emailing the customer and restart it later.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.
Don't email the customersilent_canceltrue/false
Turn on to cancel without SamCart telling the customer. The cancellation is still recorded.Default: false.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": "2026-10-20T09:00:00Z",
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "canceled",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Change next payment date

Move an active or delinquent subscription's next payment to another time in the future.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.
Next paymentnext_rebilling_datedate and timeRequired
When it should next bill. Must be in the future.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-12-01T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Create coupon

Create a coupon code: a percentage or fixed amount off, on the first payment or every payment, for every product or chosen ones. Its terms can't be changed later. Needs a SamCart plan with coupons.

Inputs

CodecodetextRequired
What customers type at checkout, up to 30 characters, no spaces.
Discountdiscount_typetextRequired
A percentage off, or a fixed amount off.One of: percentage (Percentage off), flat_rate (Fixed amount off).
Amount offamountnumberRequired
For a percentage, a whole number from 1 to 100. For a fixed amount, cents (500 is 5.00).At least 1.
Notedescriptiontext
Your own note on it; customers don't see it.
Applies tocharge_instancetext
The first payment only, or every payment of a subscription.One of: one_time (First payment only (default)), recurring (Every payment).
Can be usedusage_typetext
How often it can be redeemed.One of: unlimited (Unlimited (default)), one_time (Once in total), unique_per_email (Once per customer email).
Payments discountedmax_redemptionsnumber
For every-payment coupons: how many payments it discounts. Leave empty for all of them.Only when Applies to is Every payment. At least 1.
Productsproduct_idslist
The ids of the products it works on, up to 100. Leave empty for every product.
Startsstart_datedate and time
When it can first be used. Leave empty for now.
Endsend_datedate and time
When it stops working. Leave empty for never.

Outputs

countnumber
How many coupon records were made
couponobject
The coupon (the first, if several)
couponslist
Every coupon record made: one per product it was limited to
Example output
{
  "count": 1,
  "coupon": {
    "archived": false,
    "charge_instance": "one_time",
    "code": "SUMMER20",
    "created_at": "2026-10-01T12:00:00Z",
    "currency": "USD",
    "description": "Summer sale",
    "discount_amount": null,
    "discount_percentage": 20,
    "end_date": "2026-12-31T23:59:59Z",
    "id": "01J4X6ZCPNQ3W9GJ4X6Z0V8Q3D",
    "max_redemptions": null,
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "start_date": null,
    "type": "percentage",
    "usage_type": "unlimited"
  },
  "coupons": [
    {
      "archived": false,
      "charge_instance": "one_time",
      "code": "SUMMER20",
      "created_at": "2026-10-01T12:00:00Z",
      "currency": "USD",
      "description": "Summer sale",
      "discount_amount": null,
      "discount_percentage": 20,
      "end_date": "2026-12-31T23:59:59Z",
      "id": "01J4X6ZCPNQ3W9GJ4X6Z0V8Q3D",
      "max_redemptions": null,
      "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
      "start_date": null,
      "type": "percentage",
      "usage_type": "unlimited"
    }
  ]
}

Create product

Create a one-time or subscription product, live and in your marketplace's currency, with SamCart's default settings. Choose a billing frequency to make it a subscription, with an optional free or paid trial.

Inputs

NamenametextRequired
The name customers see.
Categoryproduct_categorytextRequired
Digital, or physical to collect a shipping address at checkout.One of: digital, physical (Physical (collects a shipping address)).
PricepricenumberRequired
In cents (4999 is 49.99): 0 for free, or at least 50. For a subscription, what each payment charges; for pay what you want, the least a customer can pay.From 0 to 99999999.
Descriptiondescriptiontext
The description customers see.
Pay what you wantpay_what_you_wanttrue/false
Let customers choose what to pay, at least the price.Default: false.
Collect sales taxcollect_taxtrue/false
Collect sales tax at checkout.Default: false.
Billssubscription_frequencytext
How often a subscription bills. Leave empty for a one-time product.One of: weekly, monthly, quarterly, yearly, custom (Every so many days).
Subscription typesubscription_typetext
Recurring bills until canceled; limited bills a set number of times. Defaults to recurring.One of: recurring (Recurring (until canceled)), limited (Limited (fixed number of payments)).
Days between paymentscustom_daysnumber
For the 'every so many days' frequency.Only when Bills is Every so many days. At least 1.
Number of paymentsnumber_of_chargesnumber
For a limited subscription: how many payments in all.Only when Subscription type is Limited (fixed number of payments). At least 1.
Trialtrial_typetext
A free trial charges nothing at checkout; a paid trial charges the trial price. Leave empty for no trial.One of: free (Free trial), paid (Paid trial).
Trial daystrial_daysnumber
How long the trial lasts before the first full payment.At least 1.
Trial pricetrial_pricenumber
For a paid trial, in cents: 0 or at least 50.Only when Trial is Paid trial. From 0 to 99999999.

Outputs

productobject
The product
Example output
{
  "product": {
    "archived": false,
    "checkout_url": "https://example.samcart.com/products/course-bundle/checkout",
    "created_at": "2026-09-01T12:00:00Z",
    "currency": "USD",
    "deleted": false,
    "description": "Every course in one bundle.",
    "has_coupons": true,
    "id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "image_url": "https://example.samcart.com/images/course-bundle.png",
    "internal_name": "Course bundle 2026",
    "name": "Course Bundle",
    "price": 4999,
    "pricing_type": "one_time",
    "product_category": "digital",
    "sales_page_url": "https://example.samcart.com/products/course-bundle",
    "sku": "COURSE-1",
    "slug": "course-bundle",
    "tags": [
      "courses"
    ],
    "test_mode": false,
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

Get charge

Get one charge: what was captured, for which order and subscription, and whether it was refunded.

Inputs

Charge IDcharge_idtextRequired
The charge's id, from 'List charges' or a trigger.

Outputs

chargeobject
The charge
Example output
{
  "charge": {
    "card_used": "Visa 4242",
    "created_at": "2026-10-15T14:00:02Z",
    "currency": "USD",
    "customer_id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
    "id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
    "order_date": "2026-10-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "processor_name": "Stripe",
    "processor_transaction_id": "ch_3Rg5YoKc2oulIASm1inPf7t0",
    "status": "charged",
    "subscription_id": null,
    "test_mode": false,
    "total": 4999,
    "type": "one_time"
  }
}

Get customer

Get one customer with every address on file and their saved payment methods. Their orders, charges and subscriptions are found with the list steps, filtered by this customer.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'List customers' or a trigger.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "addresses": [
      {
        "city": "Austin",
        "country": "US",
        "postal_code": "78701",
        "region": "TX",
        "state": "TX",
        "street": "100 Main Street",
        "type": "billing"
      }
    ],
    "created_at": "2026-10-15T14:00:00Z",
    "deleted_at": null,
    "email": "sam@example.com",
    "first_name": "Sam",
    "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
    "last_name": "Buyer",
    "marketing_consent_status": "opted_in",
    "payment_methods": [
      {
        "brand": "Visa",
        "expiration_month": 12,
        "expiration_year": 2028,
        "last_4": "4242",
        "processor": "Stripe",
        "type": "card"
      }
    ],
    "phone": "+15125550123",
    "tags": [
      "vip"
    ],
    "test_mode": false,
    "updated_at": "2026-10-15T14:00:00Z"
  }
}

Get order

Get one order with its customer, addresses, payment method, checkout custom field answers and every product with its price, charge and subscription.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or a trigger.

Outputs

orderobject
The order
Example output
{
  "order": {
    "billing_address": {
      "city": "Austin",
      "country": "US",
      "postal_code": "78701",
      "region": "TX",
      "state": "TX",
      "street": "100 Main Street"
    },
    "card_used": "Visa 4242",
    "cart_items": [
      {
        "charge_id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
        "coupon_id": null,
        "currency": "USD",
        "pricing_type": "recurring_subscription",
        "processor_transaction_id": "ch_3Rg5YoKc2oulIASm1inPf7t0",
        "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
        "product_name": "Course Bundle",
        "quantity": 1,
        "sku": "COURSE-1",
        "status": "charged",
        "subscription_id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
        "upsell_id": null
      }
    ],
    "created_at": "2026-10-15T14:00:00Z",
    "currency": "USD",
    "custom_fields": {
      "shirt-size": "Medium"
    },
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "discount": 0,
    "id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "ip_address": "203.0.113.7",
    "payment_method": "card",
    "processor_name": "Stripe",
    "shipping": 0,
    "shipping_address": null,
    "status": "charged",
    "subtotal": 4999,
    "taxes": 0,
    "test_mode": false,
    "total": 4999,
    "updated_at": "2026-10-15T14:00:05Z"
  }
}

Get product

Get one product with its description, price, checkout link, tags and whether coupons apply. A deleted product still comes back, marked deleted.

Inputs

Productproduct_idtextRequired
The product.

Outputs

productobject
The product
Example output
{
  "product": {
    "archived": false,
    "checkout_url": "https://example.samcart.com/products/course-bundle/checkout",
    "created_at": "2026-09-01T12:00:00Z",
    "currency": "USD",
    "deleted": false,
    "description": "Every course in one bundle.",
    "has_coupons": true,
    "id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "image_url": "https://example.samcart.com/images/course-bundle.png",
    "internal_name": "Course bundle 2026",
    "name": "Course Bundle",
    "price": 4999,
    "pricing_type": "one_time",
    "product_category": "digital",
    "sales_page_url": "https://example.samcart.com/products/course-bundle",
    "sku": "COURSE-1",
    "slug": "course-bundle",
    "tags": [
      "courses"
    ],
    "test_mode": false,
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

Get subscription

Get one subscription with what each payment charges, its coupon, any scheduled cancellation, what it has collected, failed payments and the customer.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

List abandoned checkouts

List prospects: people who entered their details on a checkout but didn't buy, once per product, filtered by email, product or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Emailemailtext
Only prospects with this exact email.
Productproduct_idtext
Only prospects from this product's checkout.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
prospectslist
The prospects on this page
Example output
{
  "count": 1,
  "next_cursor": "",
  "prev_cursor": "",
  "prospects": [
    {
      "created_at": "2026-10-18T10:00:00Z",
      "email": "alex@example.com",
      "first_name": "Alex",
      "id": "01J4X6ZPRSPQ3W9GJ4X6Z0V8Q3",
      "last_name": "Browser",
      "phone": null,
      "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
      "test_mode": false,
      "updated_at": "2026-10-18T10:00:00Z"
    }
  ]
}

List charges

List successful charges (first payments and subscription rebills) with their amount and refund status, filtered by order, customer, subscription, type, status or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Order IDorder_idtext
Only those for this order (its id).
Customer IDcustomer_idtext
Only those for this customer (its id).
Subscription IDsubscription_idtext
Only those for this subscription (its id).
Charge typecharge_typelist
Only charges of any of these kinds. Leave empty for all.One or more of: one_time (One-time), recurring (Subscription rebill), limited (Limited subscription payment).
Refund statusstatuslist
Only charges in any of these states. Leave empty for all.One or more of: charged, refunded, partially_refunded (Partially refunded).
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

chargeslist
The charges on this page
countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
Example output
{
  "charges": [
    {
      "card_used": "Visa 4242",
      "created_at": "2026-10-15T14:00:02Z",
      "currency": "USD",
      "customer_id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
      "order_date": "2026-10-15T14:00:00Z",
      "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
      "processor_name": "Stripe",
      "processor_transaction_id": "ch_3Rg5YoKc2oulIASm1inPf7t0",
      "status": "charged",
      "subscription_id": null,
      "test_mode": false,
      "total": 4999,
      "type": "one_time"
    }
  ],
  "count": 1,
  "next_cursor": "",
  "prev_cursor": ""
}

List coupons

List coupons with their code, discount and limits, filtered by code, product, archived or date. A coupon for several products is listed once per product. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Codecodetext
Only coupons with this exact code.
Productproduct_idtext
Only coupons limited to this product (coupons for every product aren't included).
Archivedarchivedtext
Yes for only archived coupons, no for only current ones. Leave empty for both.One of: true (Yes), false (No).
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
couponslist
The coupons on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
Example output
{
  "count": 1,
  "coupons": [
    {
      "archived": false,
      "charge_instance": "one_time",
      "code": "SUMMER20",
      "created_at": "2026-10-01T12:00:00Z",
      "currency": "USD",
      "description": "Summer sale",
      "discount_amount": null,
      "discount_percentage": 20,
      "end_date": "2026-12-31T23:59:59Z",
      "id": "01J4X6ZCPNQ3W9GJ4X6Z0V8Q3D",
      "max_redemptions": null,
      "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
      "start_date": null,
      "type": "percentage",
      "usage_type": "unlimited"
    }
  ],
  "next_cursor": "",
  "prev_cursor": ""
}

List customers

List customers with their contact details, tags and SMS consent, filtered by email, phone or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Emailemailtext
Only the customer with this email (exact, any capitals).
Phonephonetext
Only customers with this exact phone number.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
customerslist
The customers on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
Example output
{
  "count": 1,
  "customers": [
    {
      "created_at": "2026-10-15T14:00:00Z",
      "deleted_at": null,
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "marketing_consent_status": "opted_in",
      "phone": "+15125550123",
      "tags": [
        "vip"
      ],
      "test_mode": false,
      "updated_at": "2026-10-15T14:00:00Z"
    }
  ],
  "next_cursor": "",
  "prev_cursor": ""
}

List failed charges

List payment attempts that failed (at checkout or on a subscription rebill) with the processor's reason, filtered by order, customer, subscription, payment method or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Order IDorder_idtext
Only those for this order (its id).
Customer IDcustomer_idtext
Only those for this customer (its id).
Subscription IDsubscription_idtext
Only those for this subscription (its id).
Payment methodsourcelist
Only attempts with any of these payment methods. Leave empty for all.One or more of: card, paypal, venmo, affirm, klarna, afterpay_clearpay (Afterpay / Clearpay), us_bank_account (US bank account), link.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
failed_chargeslist
The failed charges on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
Example output
{
  "count": 1,
  "failed_charges": [
    {
      "card_used": "Visa 0341",
      "created_at": "2026-10-20T06:00:00Z",
      "currency": "USD",
      "customer_id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "error": "Your card was declined.",
      "id": "01J4X6ZFCHGQ3W9GJ4X6Z0V8Q3",
      "order_id": null,
      "source": "card",
      "subscription_id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
      "test_mode": false,
      "total": 1999
    }
  ],
  "next_cursor": "",
  "prev_cursor": ""
}

List orders

List orders with their totals, status, customer and products, filtered by customer, email, status, product, coupon code or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Customer IDcustomer_idtext
Only those for this customer (its id).
Customer emailemailtext
Only orders by this exact email.
Statusstatuslist
Only orders in any of these statuses. Leave empty for all.One or more of: pending, charged, declined, refunded, partially_refunded (Partially refunded), partially_declined (Partially declined), fulfilled, reversed.
Productproduct_idtext
Only orders that include this product.
Coupon codecoupon_codetext
Only orders that used this exact code.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
orderslist
The orders on this page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
Example output
{
  "count": 1,
  "next_cursor": "",
  "orders": [
    {
      "cart_items": [
        {
          "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
          "product_name": "Course Bundle",
          "quantity": 1,
          "sku": "COURSE-1",
          "status": "charged",
          "subscription_id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B"
        }
      ],
      "created_at": "2026-10-15T14:00:00Z",
      "currency": "USD",
      "customer": {
        "email": "sam@example.com",
        "first_name": "Sam",
        "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
        "last_name": "Buyer"
      },
      "discount": 0,
      "id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
      "payment_method": "card",
      "shipping": 0,
      "status": "charged",
      "subtotal": 4999,
      "taxes": 0,
      "test_mode": false,
      "total": 4999,
      "updated_at": "2026-10-15T14:00:05Z"
    }
  ],
  "prev_cursor": ""
}

List products

List products with their price, pricing type, checkout link and whether they are archived or in test mode, filtered by archived, category, pricing type, SKU or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Archivedarchivedtext
Yes for only archived products, no for only current ones. Leave empty for both.One of: true (Yes), false (No).
Categoryproduct_categorylist
Digital, physical, or leave empty for both.One or more of: digital, physical (Physical (collects a shipping address)).
Pricing typepricing_typelist
Only products priced any of these ways. Leave empty for all.One or more of: one_time (One-time), recurring_subscription (Recurring subscription), limited_subscription (Limited subscription), pwyw_one_time (Pay what you want, one-time), pwyw_recurring_subscription (Pay what you want, recurring), pwyw_limited_subscription (Pay what you want, limited).
SKUskutext
Only the product with this exact SKU.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
productslist
The products on this page
Example output
{
  "count": 1,
  "next_cursor": "",
  "prev_cursor": "",
  "products": [
    {
      "archived": false,
      "checkout_url": "https://example.samcart.com/products/course-bundle/checkout",
      "created_at": "2026-09-01T12:00:00Z",
      "currency": "USD",
      "id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
      "internal_name": "Course bundle 2026",
      "name": "Course Bundle",
      "price": 4999,
      "pricing_type": "one_time",
      "product_category": "digital",
      "sales_page_url": "https://example.samcart.com/products/course-bundle",
      "sku": "COURSE-1",
      "slug": "course-bundle",
      "test_mode": false,
      "updated_at": "2026-10-01T12:00:00Z"
    }
  ]
}

List refunds

List refunds with their amount and the charge, order and customer they belong to, filtered by order, charge, customer or date. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Order IDorder_idtext
Only those for this order (its id).
Charge IDcharge_idtext
Only those for this charge (its id).
Customer IDcustomer_idtext
Only those for this customer (its id).
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
refundslist
The refunds on this page
Example output
{
  "count": 1,
  "next_cursor": "",
  "prev_cursor": "",
  "refunds": [
    {
      "amount": 2500,
      "charge_id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
      "created_at": "2026-10-16T09:00:00Z",
      "currency": "USD",
      "customer_id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "id": "01J4X6ZRFNDQ3W9GJ4X6Z0V8Q3",
      "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
      "processor_refund_id": "re_3Rg5YoKc2oulIASm1x0Lz9Qa",
      "test_mode": false
    }
  ]
}

List subscriptions

List subscriptions with their product, price, status, customer and next payment, filtered by customer, product, order, status, type, a pending cancellation, or when they next bill, ended or started. Gets one page; to see more, run it again with the next_cursor it gives.

Inputs

Customer IDcustomer_idtext
Only those for this customer (its id).
Productproduct_idtext
Only subscriptions to this product.
Order IDorder_idtext
Only those for this order that started them (its id).
Statusstatuslist
Only subscriptions in any of these statuses. One set to cancel later is still active. Leave empty for all.One or more of: active, canceled, delinquent, completed, paused, invalid_processor (Invalid processor), sca_required (Authentication required), deleted.
Typesubscription_typelist
Recurring, limited, or leave empty for both.One or more of: recurring (Recurring (until canceled)), limited (Limited (fixed number of payments)).
Set to cancel laterscheduled_to_canceltext
Yes for only those with a cancellation scheduled, no for only those without. Leave empty for both.One of: true (Yes), false (No).
Next payment on or afterrebilling_afterdate and time
Only those whose next payment is at or after this time.
Next payment on or beforerebilling_beforedate and time
Only those whose next payment is at or before this time.
Ended on or afterended_afterdate and time
Only those that ended (canceled, completed or deleted) at or after this time. Pair with the canceled status for cancellations only.
Ended on or beforeended_beforedate and time
Only those that ended at or before this time.
Created on or aftercreated_afterdate and time
Only those created at or after this time.
Created on or beforecreated_beforedate and time
Only those created at or before this time.
Live or testtest_modetext
Only live records, or only test-mode ones. Leave empty for both.One of: false (Live only), true (Test mode only).
Ordersorttext
Newest first unless you choose oldest first.One of: -id (Newest first (default)), id (Oldest first).
Page sizelimitnumber
How many to return, 1 to 100. SamCart's default is 25.From 1 to 100.
Page cursorcursortext
The next_cursor (or prev_cursor) from an earlier run of this step, to get that page.

Outputs

countnumber
How many records are on this page
next_cursortext
Give this as 'Page cursor' to get the next page; empty on the last page
prev_cursortext
Give this as 'Page cursor' to get the previous page; empty on the first
subscriptionslist
The subscriptions on this page
Example output
{
  "count": 1,
  "next_cursor": "",
  "prev_cursor": "",
  "subscriptions": [
    {
      "created_at": "2026-07-15T14:00:00Z",
      "currency": "USD",
      "customer": {
        "email": "sam@example.com",
        "first_name": "Sam",
        "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
        "last_name": "Buyer"
      },
      "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
      "next_rebilling_date": "2026-11-15T14:00:00Z",
      "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
      "price": 1999,
      "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
      "product_name": "Membership",
      "rebill_days": null,
      "status": "active",
      "subscription_interval": "monthly",
      "test_mode": false,
      "times_rebilled": 3,
      "total_rebills": null,
      "type": "recurring"
    }
  ]
}

Refund charge

Refund a charge through its payment processor, in full or in part. The money goes back to the buyer and this can't be undone.

Inputs

Charge IDcharge_idtextRequired
The charge's id, from 'List charges' or a trigger.
Amountamountnumber
How much to refund, in cents (2500 is 25.00). Leave empty to refund the whole charge.At least 1.

Outputs

refundobject
The refund
Example output
{
  "refund": {
    "amount": 2500,
    "charge_id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
    "created_at": "2026-10-16T09:00:00Z",
    "currency": "USD",
    "customer_id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
    "id": "01J4X6ZRFNDQ3W9GJ4X6Z0V8Q3",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "processor_refund_id": "re_3Rg5YoKc2oulIASm1x0Lz9Qa",
    "test_mode": false
  }
}

Remove scheduled cancellation

Take back a cancellation scheduled for later, so the subscription keeps billing. Fails if none is scheduled.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Restart subscription

Restart a canceled or delinquent subscription so it bills again, such as after the customer updates their card. Billed through Stripe, it charges the customer at once and the next period starts today.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": null,
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Schedule subscription cancellation

Set an active subscription to cancel at the end of its billing period or on a date. It stays active until then. If one is already scheduled, that one is kept.

Inputs

Subscription IDsubscription_idtextRequired
The subscription's id, from 'List subscriptions' or a trigger.
Cancelcancel_whentextRequired
At the end of the current billing period, or on a date you choose.One of: end_of_period (At the end of the current billing period), custom (On a date I choose).
Cancel oncancel_datedate
The future date it cancels on.Only when Cancel is On a date I choose.

Outputs

subscriptionobject
The subscription
Example output
{
  "subscription": {
    "card_used": "Visa 4242",
    "collected": 7996,
    "coupon": null,
    "created_at": "2026-07-15T14:00:00Z",
    "currency": "USD",
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "delinquency_date": null,
    "end_date": null,
    "id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
    "next_rebilling_date": "2026-11-15T14:00:00Z",
    "order_id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "price": 1999,
    "processor_name": "Stripe",
    "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "product_name": "Membership",
    "rebill_days": null,
    "recurring_price": {
      "shipping": 0,
      "subtotal": 1999,
      "taxes": 0,
      "total": 1999
    },
    "scheduled_cancellation": {
      "cancel_date": "2026-11-15",
      "status": "pending"
    },
    "start_date": "2026-07-15T14:00:00Z",
    "status": "active",
    "subscription_interval": "monthly",
    "test_mode": false,
    "times_rebilled": 3,
    "total_failed_charges": 0,
    "total_rebills": null,
    "type": "recurring"
  }
}

Update order custom fields

Change the answers to an order's checkout custom fields, by each field's slug (as 'Get order' shows them under custom_fields). Only the fields given change. An empty value erases the buyer's answer.

Inputs

Order IDorder_idtextRequired
The order's id, from 'List orders' or a trigger.
Custom fieldscustom_fieldsobjectRequired
Each field's slug with its new value, such as {"shirt-size": "Large"}. A list field takes one of its options; a checkbox takes yes or no.

Outputs

orderobject
The order
Example output
{
  "order": {
    "billing_address": {
      "city": "Austin",
      "country": "US",
      "postal_code": "78701",
      "region": "TX",
      "state": "TX",
      "street": "100 Main Street"
    },
    "card_used": "Visa 4242",
    "cart_items": [
      {
        "charge_id": "01J4X6ZCHGQ3W9GJ4X6Z0V8Q3C",
        "coupon_id": null,
        "currency": "USD",
        "pricing_type": "recurring_subscription",
        "processor_transaction_id": "ch_3Rg5YoKc2oulIASm1inPf7t0",
        "product_id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
        "product_name": "Course Bundle",
        "quantity": 1,
        "sku": "COURSE-1",
        "status": "charged",
        "subscription_id": "01J4X6ZSBSQ3W9GJ4X6Z0V8Q3B",
        "upsell_id": null
      }
    ],
    "created_at": "2026-10-15T14:00:00Z",
    "currency": "USD",
    "custom_fields": {
      "shirt-size": "Large"
    },
    "customer": {
      "email": "sam@example.com",
      "first_name": "Sam",
      "id": "01J4X6ZCVSTQ3W9GJ4X6Z0V8Q3",
      "last_name": "Buyer",
      "phone": "+15125550123"
    },
    "discount": 0,
    "id": "01J4X6Z0V8Q3W9GJ4X6Z0V8Q3W",
    "ip_address": "203.0.113.7",
    "payment_method": "card",
    "processor_name": "Stripe",
    "shipping": 0,
    "shipping_address": null,
    "status": "charged",
    "subtotal": 4999,
    "taxes": 0,
    "test_mode": false,
    "total": 4999,
    "updated_at": "2026-10-15T14:00:05Z"
  }
}

Update product

Change a product's name, internal name, SKU, description, search engine title and description, link name or one-time price, archive or restore it, or switch it between test mode and live. Only the fields given change.

Inputs

Productproduct_idtextRequired
The product to change.
Namenametext
The name customers see.
Internal nameinternal_nametext
The name only you see.
SKUskutext
The product's SKU.
Descriptiondescriptiontext
The description customers see.
Search engine titleseo_titletext
The sales page's title tag.
Search engine descriptionseo_descriptiontext
The sales page's meta description.
Link nameslugtext
The name in its sales page and checkout links: lowercase letters, digits and hyphens, unique in your marketplace. Old links stop working.
Pricepricenumber
New price in cents: 0 or at least 50. Not for subscription products.From 0 to 99999999.
Archivedarchivedtext
Yes to archive it, no to restore it.One of: true (Yes), false (No).
Test modetest_modetext
Yes puts checkouts in test mode (not charged); no makes it live.One of: true (Yes), false (No).

Outputs

productobject
The product
Example output
{
  "product": {
    "archived": false,
    "checkout_url": "https://example.samcart.com/products/course-bundle/checkout",
    "created_at": "2026-09-01T12:00:00Z",
    "currency": "USD",
    "deleted": false,
    "description": "Every course in one bundle.",
    "has_coupons": true,
    "id": "01J4X6ZPRDQ3W9GJ4X6Z0V8Q3A",
    "image_url": "https://example.samcart.com/images/course-bundle.png",
    "internal_name": "Course bundle 2026",
    "name": "Course Bundle 2027",
    "price": 4999,
    "pricing_type": "one_time",
    "product_category": "digital",
    "sales_page_url": "https://example.samcart.com/products/course-bundle",
    "sku": "COURSE-1",
    "slug": "course-bundle",
    "tags": [
      "courses"
    ],
    "test_mode": false,
    "updated_at": "2026-10-01T12:00:00Z"
  }
}

On this page