ThriveCart

App · 25 actions

Read products, offers, customers, transactions and affiliates; manage subscriptions, refunds and event notifications.

Actions

ActionWhat it does
Cancel a subscriptionCancel a subscription.
Create affiliateCreate an affiliate or register an existing affiliate for a product.
Create event subscriptionCreate event subscription.
Get bumpGet bump.
Get bump price detailsGet bump price details.
Get downsellGet downsell.
Get downsell price detailsGet downsell price details.
Get productGet product.
Get product price detailsGet product price details.
Get upsellGet upsell.
Get upsell price detailsGet upsell price details.
List bump offersList bump offers.
List downsellsList downsells.
List productsList products.
List upsellsList upsells.
Pause a subscriptionPause a subscription.
PingPing.
Read affiliate infoRead affiliate info.
Read customer informationRead customer information.
Refund a transactionRefund a transaction.
Resume a subscriptionResume a subscription.
Search affiliatesSearch affiliates.
Search transactionsSearch transactions.
Unsubscribe from an eventUnsubscribe from an event.
Update Customer Email AddressUpdate Customer Email Address.

Cancel a subscription

Cancel a subscription. This changes the connected account; use test mode for QA.

Inputs

Order IDorder_idtextRequired
Order ID
Subscription IDsubscription_idtextRequired
Subscription ID

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "message": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

Create affiliate

Create an affiliate or register an existing affiliate for a product. May send account emails.

Inputs

EmailemailtextRequired
Affiliate's email (used to sign in)
Namenametext
(Optional) Affiliate's name
Affiliateaffiliate_idtext
(Optional) Desired affiliate ID - may be updated by the system
Product IDSproduct_idslist
Array of at least one product ID to add them to
Auto approveauto_approvetrue/false
(Optional) Auto-approve the affiliate for these products?
Parent affiliateparent_affiliatenumber
(Optional) Mark this affiliate as having been referred by another?
First namefirst_nametext
(Optional) Affiliate's first name
Last namelast_nametext
(Optional) Affiliate's last name
Companycompanytext
(Optional) Affiliate's company/business name
Countrycountrytext
(Optional) 2-digit country code for affiliate's country
Citycitytext
(Optional) Affiliate's city
Statestatetext
(Optional) Affiliate's state/region
Zipziptext
(Optional) Affiliate's ZIP/post code
Trigger emailstrigger_emailstrue/false
(Optional) Trigger email to affiliate and vendor? Defaults to true

Outputs

Value.

dataobject
The new affiliate.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Create event subscription

Create event subscription. This changes the connected account; use test mode for QA.

Inputs

EventeventtextRequired
Event.One of: *, order_created, order_payment_product, order_payment_bump, order_payment_upsell, order_payment_downsell, order_rebill, order_rebill_failed, order_rebill_completed, order_rebill_cancelled, and 12 more.
Target URLtarget_urltextRequired
Target url.
Trigger fieldstrigger_fieldsobject
Trigger fields.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "subscription_id": 1
  },
  "has_more": false,
  "next_cursor": null
}

Get bump

Get bump.

Inputs

Bumpbump_idtextRequired
Bump id.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "bump_id": "example",
    "embed_type": "example",
    "label": "example",
    "name": "example",
    "payment_currency": "example",
    "product_id": "example",
    "product_name": "example",
    "slug": "example",
    "status": "example",
    "statusString": "example",
    "type": "example",
    "typeString": "example",
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get bump price details

Get bump price details.

Inputs

Bumpbump_idtextRequired
Bump id.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get downsell

Get downsell.

Inputs

Downselldownsell_idtextRequired
Downsell

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "downsell_id": "example",
    "label": "example",
    "name": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get downsell price details

Get downsell price details.

Inputs

Downselldownsell_idtextRequired
Downsell id.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get product

Get product.

Inputs

Productproduct_idtextRequired
Product

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "embed_type": "example",
    "label": "example",
    "name": "example",
    "payment_currency": "example",
    "product_id": "example",
    "slug": "example",
    "status": "example",
    "statusString": "example",
    "type": "example",
    "typeString": "example",
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get product price details

Get product price details.

Inputs

Productproduct_idtextRequired
Product id.
Affiliateaffiliate_idtext
(Optional) Provide an affiliate ID to query the commissions tailored to this specific affiliate

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get upsell

Get upsell.

Inputs

Upsellupsell_idtextRequired
Upsell

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "label": "example",
    "name": "example",
    "upsell_id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get upsell price details

Get upsell price details.

Inputs

Upsellupsell_idtextRequired
Upsell id.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List bump offers

List bump offers.

Inputs

None.

Outputs

Value.

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": [
    {
      "bump_id": "example",
      "bump_name": "example",
      "embed_type": "example",
      "id": "example",
      "name": "example",
      "payment_amount": 1,
      "payment_currency": "example",
      "product_id": "example",
      "product_label": "example",
      "product_name": "example",
      "status": "example",
      "statusString": "example",
      "type": "example",
      "typeString": "example",
      "url": "example"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

List downsells

List downsells.

Inputs

None.

Outputs

Value.

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": [
    {
      "downsell_id": "example",
      "label": "example",
      "name": "example",
      "type": "example",
      "typeString": "example"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

List products

List products.

Inputs

None.

Outputs

Value.

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": [
    {
      "embed_type": "example",
      "label": "example",
      "name": "example",
      "product_id": "example",
      "status": "example",
      "statusString": "example",
      "type": "example",
      "typeString": "example",
      "url": "example"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

List upsells

List upsells.

Inputs

None.

Outputs

Value.

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": [
    {
      "label": "example",
      "name": "example",
      "type": "example",
      "typeString": "example",
      "upsell_id": "example"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Pause a subscription

Pause a subscription. This changes the connected account; use test mode for QA.

Inputs

Order IDorder_idtextRequired
Order ID
Subscription IDsubscription_idtextRequired
Subscription ID
Auto resumeauto_resumedate and time
(Optional) Unix timestamp to automatically resume this subscription - must be 24 hours in the future

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "customer_id": "example",
    "frequency": "example",
    "message": "example",
    "plan_id": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

Ping

Ping.

Inputs

None.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "account_id": "example",
    "account_name": "example",
    "account_url": "example",
    "account_version": "example",
    "custom_domain": "example",
    "custom_domain_enabled": false,
    "user_id": "example",
    "user_name": "example",
    "user_username": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Read affiliate info

Read affiliate info.

Inputs

Affiliateaffiliate_idtextRequired
Affiliate user ID, affiliate id, or email

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "affiliate_id": "example",
    "email": "example",
    "is_favourite": false,
    "label": "example",
    "name": "example",
    "products": [
      {
        "affiliate_link": "example",
        "product_id": "example",
        "product_name": "example",
        "status": "example",
        "status_string": "example"
      }
    ],
    "user_id": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Read customer information

Read customer information.

Inputs

EmailemailtextRequired
Customer email address

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "customer": {
      "email": "example",
      "name": "example"
    },
    "lifetime_value": {
      "USD": 1
    },
    "purchases": [
      {}
    ],
    "subscriptions": [
      {
        "amount": "example",
        "currency": "example",
        "date_started": "example",
        "events": [
          {
            "amount": 1,
            "date": "example",
            "event_id": "example",
            "event_type": "example",
            "reference": "example"
          }
        ],
        "frequency": "example",
        "invoice_id": "example",
        "item_id": "example",
        "item_name": "example",
        "item_type": "example",
        "last_payment": "example",
        "next_payment": "example",
        "order_id": "example",
        "payments": "example",
        "payments_remaining": "example",
        "processor": "example",
        "status": "example",
        "subscription_id": "example",
        "subscription_reference": "example",
        "total_paid": "example"
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

Refund a transaction

Refund a transaction. This changes the connected account; use test mode for QA.

Inputs

Order IDorder_idtextRequired
Order ID
ReferencereferencetextRequired
Item reference
Reasonreasontext
Reason.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "message": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

Resume a subscription

Resume a subscription. This changes the connected account; use test mode for QA.

Inputs

Order IDorder_idtextRequired
Order ID
Subscription IDsubscription_idtextRequired
Subscription ID

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "message": "example",
    "subscription_id": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

Search affiliates

Search affiliates.

Inputs

Productproduct_idtext
(Optional) Product ID
Queryquerytext
(Optional) Search by affiliate name, email, affiliate ID
Pagepagenumber
Page number (1 through N)From 1 to 1000000.
PerPageperPagenumber
Results per page (max of 25)From 1 to 25.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "affiliates": [
      {
        "affiliate_id": "example",
        "email": "example",
        "is_favourite": false,
        "label": "example",
        "name": "example",
        "products": [
          {
            "affiliate_link": "example",
            "product_id": "example",
            "product_name": "example",
            "status": "example",
            "status_string": "example"
          }
        ],
        "user_id": "example"
      }
    ],
    "meta": {
      "results": 1,
      "total": 1
    }
  },
  "has_more": false,
  "next_cursor": null
}

Search transactions

Search transactions.

Inputs

Pagepagenumber
Page number (1 through N)From 1 to 1000000.
PerPageperPagenumber
Results per page (max of 100)From 1 to 100.
Queryquerytext
Search query (e.g. customer email, order ID, etc)
TransactionTypetransactionTypetext
'any', 'charge', 'rebill', 'refund', 'cancel'One of: any, charge, rebill, refund, cancel.
Currencycurrencytext
'usd', 'gbp', etc (optional; leave blank for all currencies)

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "meta": {
      "results": 1,
      "total": 1
    },
    "transactions": [
      {
        "amount": 1,
        "base_product": "example",
        "currency": "example",
        "customer": {
          "email": "example",
          "name": "example"
        },
        "date": "example",
        "event_id": "example",
        "invoice_id": "example",
        "item_id": 1,
        "item_type": "example",
        "order_id": "example",
        "processor": "example",
        "reference": "example",
        "time": "example",
        "timestamp": 1,
        "transaction_type": "example"
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

Unsubscribe from an event

Unsubscribe from an event. This changes the connected account; use test mode for QA.

Inputs

URLurltextRequired
Your endpoint URL to remove

Outputs

Value.

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": [
    {}
  ],
  "has_more": false,
  "next_cursor": null
}

Update Customer Email Address

Update Customer Email Address. This changes the connected account; use test mode for QA.

Inputs

Current emailcurrent_emailtextRequired
Current email.
New emailnew_emailtextRequired
New email.
Allow mergeallow_mergetrue/false
Allow merge.

Outputs

Value.

dataobject
API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "data": {
      "current_email": "example",
      "customer_id": "example",
      "previous_email": "example",
      "updated_at": "example"
    },
    "message": "example",
    "success": false
  },
  "has_more": false,
  "next_cursor": null
}

On this page