The ThriveCart API can be accessed in two ways:
\nIf you want to access your own account, you can create an API key from the settings area inside of ThriveCart.
\nIf you intend to create an application that lots of ThriveCart users can all use, you'll want to create an App, and get each user to grant you permission to access their account.
\nSee our developer portal for further details and how to get your credentials! Note that you will require a ThriveCart account to get started.
\nPlease see our PHP SDK for the official PHP SDK that can be installed via Composter, and then see the API demo project for more details and examples on how to get your access token and begin making requests to the API.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13408532","collectionId":"d1b367e5-6d66-4b28-871e-b33ece602ddc","publishedId":"TVejhANr","public":true,"customColor":{"top-bar":"272F2E","right-sidebar":"272822","highlight":"01C5C5"},"publishDate":"2020-11-10T08:08:09.000Z"},"item":[{"name":"Ping","id":"26b856d3-5299-4ee6-80b5-1f6e3c73dedc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://thrivecart.com/api/external/ping","description":"Get information about the account that your API key or access token grants access to. No parameters are required for this endpoint. It's also useful to check the validity of your token.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Product ID
\n","type":"text/plain"},"type":"string","value":"","key":"product_id"}]}},"response":[{"id":"54366844-2b4f-4a8a-b4b6-503ca4185be7","name":"Product details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://thrivecart.com/api/external/products/:product_id","host":["https://thrivecart.com"],"path":["api","external","products",":product_id"],"variable":[{"key":"product_id","value":"","type":"string","description":"Product ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-ThriveCart-Account-Name","value":"myaccount"},{"key":"X-ThriveCart-Account-URL","value":"https://myaccount.thrivecart.com/"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"product_id\": \"1\",\n \"name\": \"My Product\",\n \"slug\": \"my-product\",\n \"label\": \"Internal label for this product\",\n \"status\": \"2\",\n \"statusString\": \"live\",\n \"type\": \"1\",\n \"typeString\": \"digital\",\n \"payment_currency\": \"USD\",\n \"url\": \"https://myaccount.thrivecart.com/my-product/\",\n \"embed_type\": \"standard\"\n}"}],"_postman_id":"e71e25a2-b867-42c7-8870-f3218f221bb5"},{"name":"Get product price details","id":"f0f29864-9f31-49e1-9552-efb82d05b83d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://thrivecart.com/api/external/products/:product_id/pricing_options?affiliate_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Provide an affiliate ID to query the commissions tailored to this specific affiliate
\n","type":"text/plain"},"key":"affiliate_id","value":""}],"variable":[{"id":"bcf43e31-7cbb-475a-b358-4fb871d5033f","type":"any","value":"","key":"product_id"}]}},"response":[],"_postman_id":"f0f29864-9f31-49e1-9552-efb82d05b83d"},{"name":"Get bump","id":"c29e8614-a5b6-472a-8596-ee999ec30cb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://thrivecart.com/api/external/bumps/:bump_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Upsell ID
\n","type":"text/plain"},"type":"string","value":"","key":"upsell_id"}]}},"response":[{"id":"e3181ee8-6d91-44a8-8068-b1e92596faf0","name":"Upsell details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://thrivecart.com/api/external/upsells/:upsell_id","host":["https://thrivecart.com"],"path":["api","external","upsells",":upsell_id"],"variable":[{"id":"60197267-ba54-44a2-b793-c47ff5e49171","key":"upsell_id","value":"1","type":"string","description":"Upsell ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-ThriveCart-Account-Name","value":"myaccount"},{"key":"X-ThriveCart-Account-URL","value":"https://myaccount.thrivecart.com/"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"upsell_id\": \"1\",\n \"name\": \"Example Upsell #123\",\n \"label\": \"Internal label for this upsell\"\n}"}],"_postman_id":"008cb72d-479d-46ca-9822-5cd103cfa6a5"},{"name":"Get upsell price details","id":"4e0aab1b-6dab-43d0-9bc2-b11dd60b72b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://thrivecart.com/api/external/upsells/:upsell_id/pricing_options","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Downsell ID
\n","type":"text/plain"},"type":"string","value":"","key":"downsell_id"}]}},"response":[{"id":"0140c21f-71e9-4d11-9982-8834297cd6e3","name":"Downsell details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://thrivecart.com/api/external/downsells/:downsell_id","host":["https://thrivecart.com"],"path":["api","external","downsells",":downsell_id"],"variable":[{"id":"7fed9aae-1ede-4181-b9c4-70d370a37a6e","key":"downsell_id","value":"1","type":"string","description":"Downsell ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-ThriveCart-Account-Name","value":"myaccount"},{"key":"X-ThriveCart-Account-URL","value":"https://myaccount.thrivecart.com/"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"downsell_id\": \"1\",\n \"name\": \"My Demo Downsell\",\n \"label\": \"Internal label for this downsell\"\n}"}],"_postman_id":"abe3e192-0aa8-4704-99fe-951226c61ed7"},{"name":"Get downsell price details","id":"2de7ff17-d146-49e3-8e13-55c26ed5647e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://thrivecart.com/api/external/downsells/:downsell_id/pricing_options","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","type":"text"}],"url":"https://thrivecart.com/api/external/transactions?page=1&perPage=10&query=&transactionType=any¤cy","description":"Search through transaction events and return the info about activity within your account.
\nEvents such as charges, rebills, refunds and cancellations will be included under the transaction_type key.
Page number (1 through N)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Results per page (max of 100)
\n","type":"text/plain"},"key":"perPage","value":"10"},{"description":{"content":"Search query (e.g. customer email, order ID, etc)
\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"'any', 'charge', 'rebill', 'refund', 'cancel'
\n","type":"text/plain"},"key":"transactionType","value":"any"},{"description":{"content":"'usd', 'gbp', etc (optional; leave blank for all currencies)
\n","type":"text/plain"},"key":"currency","value":null}],"variable":[]}},"response":[{"id":"09d0fdbe-78b0-4810-869b-e6a027b05bd0","name":"Search transactions","originalRequest":{"method":"GET","header":[{"key":"X-TC-Mode","value":"live","description":"(Optional) Operate in test mode, or live mode","type":"text"}],"url":{"raw":"https://thrivecart.com/api/external/transactions?page=1&perPage=25&query=&transactionType=any","host":["https://thrivecart.com"],"path":["api","external","transactions"],"query":[{"key":"page","value":"1","description":"Page number (1 through N)"},{"key":"perPage","value":"25","description":"Results per page (max of 25)"},{"key":"query","value":"","description":"Search query (e.g. customer email, order ID, etc)"},{"key":"transactionType","value":"any","description":"'any', 'stripe', 'authorize', or 'paypal'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-ThriveCart-Account-Name","value":"myaccount"},{"key":"X-ThriveCart-Account-URL","value":"https://myaccount.thrivecart.com/"}],"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"event_id\": \"446660\",\n \"base_product\": \"1\",\n \"date\": \"2020-11-15\",\n \"time\": \"2020-11-15 17:01:43\",\n \"timestamp\": 1605459703,\n \"transaction_type\": \"rebill\",\n \"item_type\": \"product\",\n \"item_id\": 1,\n \"amount\": 10000,\n \"order_id\": \"7700\",\n \"invoice_id\": \"1467\",\n \"currency\": \"USD\",\n \"processor\": \"paypal\",\n \"customer\": {\n \"name\": \"Demo Customer\",\n \"email\": \"demo@thrivecart.com\"\n },\n \"reference\": \"product-222-138\"\n },\n {\n \"event_id\": \"446642\",\n \"base_product\": \"2\",\n \"date\": \"2020-11-15\",\n \"time\": \"2020-11-15 16:22:52\",\n \"timestamp\": 1605457372,\n \"transaction_type\": \"rebill\",\n \"item_type\": \"product\",\n \"item_id\": 2,\n \"amount\": 3300,\n \"order_id\": \"18584\",\n \"invoice_id\": \"2563\",\n \"currency\": \"USD\",\n \"processor\": \"paypal\",\n \"customer\": {\n \"name\": \"Other Demo Customer\",\n \"email\": \"demo-2@thrivecart.com\"\n }\n }\n ],\n \"meta\": {\n \"total\": 8358,\n \"results\": 25\n }\n}"}],"_postman_id":"f36d21e1-8d3b-4d96-b195-50970a703ceb"},{"name":"Read customer information","id":"0195ec0f-2a25-4d81-ab97-a98070057641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-TC-Mode","value":"live","description":"(Optional) Operate in test mode, or live mode
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"","description":"Customer email address
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/customer","description":"Read the full history of an individual customer and all of their purchases and subscriptions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"order_id","value":"851411","description":"Order ID
\n","type":"text"},{"key":"subscription_id","value":"253","description":"Subscription ID
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/cancelSubscription","description":"Cancel a subscription using the order ID and subscription ID pulled from either a Transaction search or the full history of a customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","key":"X-TC-Mode","type":"text","value":"live"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Order ID
\n","key":"order_id","type":"text","value":"851362"},{"description":"Item reference
\n","key":"reference","type":"text","value":"product-299"}]},"url":"https://thrivecart.com/api/external/refund","description":"Refund a specific transaction using the order ID and purchase reference pulled from either a Transaction search or the full history of a customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"order_id","value":"","description":"Order ID
\n","type":"text"},{"key":"subscription_id","value":"","description":"Subscription ID
\n","type":"text"},{"key":"auto_resume","value":"","description":"(Optional) Unix timestamp to automatically resume this subscription - must be 24 hours in the future
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/pauseSubscription","description":"Pause a subscription using the order ID and subscription ID pulled from either a Transaction search or the full history of a customer.
\nNote that you can provide an optional timestamp to automatically resume the subscription on that date, or leave this blank to pause indefinitely.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"order_id","value":"","description":"Order ID
\n","type":"text"},{"key":"subscription_id","value":"","description":"Subscription ID
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/resumeSubscription","description":"Resume a subscription using the order ID and subscription ID pulled from either a Transaction search or the full history of a customer.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Search for affiliates by the product ID they're approved for, or by their name, email, or affiliate ID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Product ID
\n","type":"text/plain"},"key":"product_id","value":null},{"description":{"content":"(Optional) Search by affiliate name, email, affiliate ID
\n","type":"text/plain"},"key":"query","value":""},{"description":{"content":"Page number (1 through N)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Results per page (max of 25)
\n","type":"text/plain"},"key":"perPage","value":"5"}],"variable":[]}},"response":[{"id":"de3557f4-8941-431c-bf67-6270319b98fd","name":"Search affiliates","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://thrivecart.com/api/external/affiliates?product_id&query=&page=1&perPage=5","host":["https://thrivecart.com"],"path":["api","external","affiliates"],"query":[{"key":"product_id","value":null,"description":"(Optional) Product ID"},{"key":"query","value":"","description":"(Optional) Search by affiliate name, email, affiliate ID"},{"key":"page","value":"1","description":"Page number (1 through N)"},{"key":"perPage","value":"5","description":"Results per page (max of 25)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-ThriveCart-Account-Name","value":"myaccount"},{"key":"X-ThriveCart-Account-URL","value":"https://myaccount.thrivecart.com/"}],"cookie":[],"responseTime":null,"body":"{\n \"affiliates\": [\n {\n \"user_id\": \"649\",\n \"email\": \"alexis_fortier@thrivecart.com\",\n \"affiliate_id\": \"alexis_fortier\",\n \"label\": \"alexis_fortier (alexis_fortier@thrivecart.com)\",\n \"name\": \"Alexis Fortier\",\n \"is_favourite\": false,\n \"products\": [\n {\n \"product_id\": \"250\",\n \"product_name\": \"My Demo Subscription\",\n \"status_string\": \"active\",\n \"status\": \"2\",\n \"affiliate_link\": \"https://alexis_fortier--myaccount.thrivecart.com/my-demo-subscription/\"\n },\n {\n \"product_id\": \"296\",\n \"product_name\": \"Demo Product\",\n \"status_string\": \"active\",\n \"status\": \"2\",\n \"affiliate_link\": \"https://alexis_fortier--myaccount.thrivecart.com/demo-product/\"\n }\n ]\n },\n {\n \"user_id\": \"650\",\n \"email\": \"amy_greene_dittz@thrivecart.com\",\n \"affiliate_id\": \"amy_greene_dittz\",\n \"label\": \"amy_greene_dittz (amy_greene_dittz@thrivecart.com)\",\n \"name\": \"Amy Greene-Dittz\",\n \"is_favourite\": false,\n \"products\": [\n {\n \"product_id\": \"250\",\n \"product_name\": \"My Demo Subscription\",\n \"status_string\": \"active\",\n \"status\": \"2\",\n \"affiliate_link\": \"https://amy_greene_dittz--myaccount.thrivecart.com/my-demo-subscription/\"\n },\n {\n \"product_id\": \"296\",\n \"product_name\": \"Demo Product\",\n \"status_string\": \"active\",\n \"status\": \"2\",\n \"affiliate_link\": \"https://amy_greene_dittz--myaccount.thrivecart.com/demo-product/\"\n }\n ]\n }\n ],\n \"meta\": {\n \"total\": 5672,\n \"results\": 2\n }\n}"}],"_postman_id":"61522093-225f-4425-8277-0691ea9edc15"},{"name":"Read affiliate info","id":"abb91e3a-8999-47cc-b0bb-a52484ff2f27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"affiliate_id","value":"","description":"Affiliate user ID, affiliate id, or email
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliate","description":"Return the information about a specific affiliate by their affiliate ID, their numeric user ID, or their email address.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate's email (used to sign in)
\n"},{"key":"name","value":"","type":"text","description":"(Optional) Affiliate's name
\n"},{"key":"affiliate_id","value":"","type":"text","description":"(Optional) Desired affiliate ID - may be updated by the system
\n"},{"key":"product_ids","value":"","type":"text","description":"Array of at least one product ID to add them to
\n"},{"key":"auto_approve","value":"","type":"text","description":"(Optional) Auto-approve the affiliate for these products?
\n"},{"key":"parent_affiliate","value":"","type":"text","description":"(Optional) Mark this affiliate as having been referred by another?
\n"},{"key":"first_name","value":"","type":"text","description":"(Optional) Affiliate's first name
\n"},{"key":"last_name","value":"","type":"text","description":"(Optional) Affiliate's last name
\n"},{"key":"company","value":"","type":"text","description":"(Optional) Affiliate's company/business name
\n"},{"key":"country","value":"","type":"text","description":"(Optional) 2-digit country code for affiliate's country
\n"},{"key":"city","value":"","type":"text","description":"(Optional) Affiliate's city
\n"},{"key":"state","value":"","type":"text","description":"(Optional) Affiliate's state/region
\n"},{"key":"zip","value":"","type":"text","description":"(Optional) Affiliate's ZIP/post code
\n"},{"key":"trigger_emails","value":"","description":"(Optional) Trigger email to affiliate and vendor? Defaults to true
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliates","description":"Create a new affiliate in your account.
\nYou can optionally specify an affiliate_id key to set their preferred affiliate ID. Affiliate IDs are unique across the system, so this may be modified by the system to ensure uniqueness.
If you do not specify any affiliate_id, we will generate one based on the user's name or email address.
If the user already exists in the system and has an affiliate ID set already, your parameter will be ignored and their affiliate ID will not be modified.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Mark an affiliate as a 'favorite' or VIP affiliate.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"c8bae6cb-9c82-494b-8f13-d1bcca073389"},{"name":"Un-favourite an affiliate","id":"addc75f2-5799-4046-9dfb-d19b9d26b16a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/unfavorite","description":"Remove the 'favorite' marker from an affiliate.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"addc75f2-5799-4046-9dfb-d19b9d26b16a"},{"name":"Register affiliate for a product","id":"966cd0b6-82f5-4bfd-aed7-30c850c78fac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"product_ids","value":"","description":"Array of at least one product ID to add them to
\n","type":"text"},{"key":"auto_approve","value":"","description":"(Optional) Auto-approve the affiliate for these products?
\n","type":"text"},{"key":"trigger_emails","value":"","description":"(Optional) Trigger email to affiliate and vendor? Defaults to true
\n","type":"text"},{"key":"parent_affiliate","value":"","description":"(Optional) Mark this affiliate as having been referred by another?
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/register","description":"Register an existing affiliate for a specific product or list of products.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"966cd0b6-82f5-4bfd-aed7-30c850c78fac"},{"name":"Approve an affiliate for a product","id":"728949c2-08ac-45f1-bf07-291043882a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"product_ids","value":"","description":"Array of at least one product ID to approve their application for
\n","type":"text"},{"key":"trigger_emails","value":"","description":"(Optional) Trigger email to affiliate and vendor? Defaults to true
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/approve","description":"Approve an affiliate for a pending application to a product or products. Note, if the application isn't already pending, no changes will be made.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"728949c2-08ac-45f1-bf07-291043882a00"},{"name":"Reject an affiliate for a product","id":"e8773f56-a27f-4c7f-b056-0582e2ba89e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"product_ids","value":"","description":"Array of at least one product ID to reject their application for
\n","type":"text"},{"key":"trigger_emails","value":"","description":"(Optional) Trigger email to affiliate and vendor? Defaults to true
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/reject","description":"Approve an affiliate for a pending application to a product or products. Note, if the application isn't already pending, no changes will be made.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"e8773f56-a27f-4c7f-b056-0582e2ba89e8"},{"name":"Specify custom commissions","id":"85d41c18-1938-4b2b-855a-148b4fd1b0dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"product_id","value":"","description":"Product ID to apply custom commissions for
\n","type":"text"},{"key":"commission_object","value":"","description":"Custom commissions object (or null to remove any custom commissions set for this product)
\n","type":"text"}]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/custom_commissions","description":"Specify a block of custom commissions for a specific affiliate and product they are promoting.
\nThis enables you to override the affiliate much like affiliate rules, and change how much, when, and how they get paid.
\nSee our example SDK for further examples and insight.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"85d41c18-1938-4b2b-855a-148b4fd1b0dc"},{"name":"Delete affiliate user","id":"1b7f530e-59e0-46ff-81a0-75a503c5278d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://thrivecart.com/api/external/affiliates/:affiliate_id/delete","description":"Return the information about a specific affiliate by their affiliate ID, their numeric user ID, or their email address.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Affiliate ID
\n","type":"text/plain"},"type":"any","value":"","key":"affiliate_id"}]}},"response":[],"_postman_id":"1b7f530e-59e0-46ff-81a0-75a503c5278d"},{"name":"Create new student","id":"45f67976-3201-48f8-b8d5-0284e2c98669","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"email","value":"","type":"text","description":"Student's email (used to sign in)
\n"},{"key":"name","value":"","type":"text","description":"(Optional) Student's name (max length: 150 characters)
\n"},{"key":"course_id","value":"","type":"text","description":"Course ID to grant access to
\n"},{"key":"tags[]","value":"","type":"text","description":"(Optional) Array of tags to apply to the student
\n"},{"key":"order_info[order_id]","value":"","type":"text","description":"(Optional) Associate this with a ThriveCart order
\n"},{"key":"order_info[purchase_type]","value":"","description":"(Optional) If associating with a ThriveCart order, specify the type of purchase (product, bump, upsell, downsell)
\n","type":"text"},{"key":"order_info[purchase_id]","value":"","description":"(Optional) If associating with a ThriveCart order, specify the numeric ID of the item purchased
\n","type":"text"},{"key":"trigger_emails","value":"true","type":"text","description":"(Optional) Trigger email to student? Defaults to true
\n"}]},"url":"https://thrivecart.com/api/external/students","description":"Create a new student in your Learn account.
\nSpecify the student's email address (which they will use to sign in), and the numeric course ID to add them to.
\nYou will receive a key auto_signin_url which will either take them to set up their password for the first time (if they aren't a student of yours already), or to sign in to your course automatically. Students should be taken here immediately after creating their access.
You may specify an array of tags to apply to them.
\nYou may also specify an order ID, purchase type and purchase ID to assign this relationship to a purchase of theirs. The system will then automatically cancel their membership if the corresponding subscription is cancelled (depending on your course settings).
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","key":"X-TC-Mode","type":"text","value":"live"}],"body":{"mode":"raw","raw":"{\"event\": \"*\", \"target_url\": \"https://webhook.site/7f5edced-00f7-43fb-833d-38e8cbdc6251\", \"trigger_fields\": {\"mode_int\": 2}}","options":{"raw":{"language":"json"}}},"url":"https://thrivecart.com/api/external/subscribe","description":"Subscribe an endpoint to receive custom webhook notifications. Accepts JSON containing event, target_url and trigger_fields.
You must have registered the beginning of your target URL with your app. For example, to receive events at https://mysite.com/webhook, you must register at least https://mysite.com within your app's URL settings or you will receive an error.
Important: Unsubscribing is done by URL. As such, as highly recommend creating a unique URL for each subscription you create!
\n* (receives all events)order_payment_product (notified when a product is purchased)order_payment_bump (notified when a bump offer is purchased)order_payment_upsell (notified when an upsell is purchased)order_payment_downsell (notified when a downsell is purchased)order_payment_declined_product (notified when a purchase is declined)cart_abandoned (notified when a cart is abandoned)order_refund (notified when a refund is issused)order_rebill (notified on successful recurring payment)order_rebill_failed (notified when a recurring payment fails)order_rebill_cancelled (notified on subscription cancellation)order_rebill_completed (notified once all payments in a split pay have been completed)subscription_paused (notified when a subscription is paused)subscription_resumed (notified when a subscription is resumed)affiliate_created (notified when a new affiliate is created)affiliate_approved (notified when an affiliate is approved for a product)affiliate_rejected (notified when an affiliate is rejected from a product)affiliate_commission_earned (notified when an affiliate earns commission)affiliate_commission_payout (notified when an affiliate is paid some commission)affiliate_commission_refund (notified when an affiliate has commission clawed back)See the detailed documentation on our developer site to see examples and learn how to filter using trigger fields.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n","key":"X-TC-Mode","type":"text","value":"live"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Your endpoint URL to remove
\n","key":"url","type":"text","value":""}]},"url":"https://thrivecart.com/api/external/unsubscribe","description":"Unsubscribe an endpoint and no longer receive notifications to it.
\nImportant: As noted when creating an event subscription, we highly recommend using random and unique URLs for each subscription so that they are easily removable.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"(Optional) Operate in test mode, or live mode
\n"}],"body":{"mode":"raw","raw":"{\n \"current_email\": \"john.old@example.com\",\n \"new_email\": \"john.new@example.com\",\n \"allow_merge\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://thrivecart.com/api/external/customerEmailUpdate","description":"Update a customer's email address in your ThriveCart account. This affects all their orders and customer hub access associated with the customer. When the new email matches an existing customer in your account, explicit merge confirmation is required to prevent accidental data consolidation.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"