sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON. The authorization used is Basic Authentication
\n\nRequests
\nAPI requests that call for a request body are expected to be in JSON Format.
\nResponses
\nThe v2 standard JSON responses will usually contain at least the following:
\nList Responses
\nGET requests that return a list of entities will usually contain the following:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4811546","collectionId":"ef86aea7-73d2-4a65-b467-28938bb07563","publishedId":"TWDamFCD","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"757575","highlight":"0076FF"},"publishDate":"2025-02-14T16:55:40.000Z"},"item":[{"name":"Affiliates","item":[{"name":"Permissions","item":[{"name":"Get User Affiliate Permissions","id":"9210b512-de0f-4add-b328-fb9299bc4044","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}affiliate-permissions/1/all","description":"Fetch a list of all affiliate permission objects associated with a platform user.
\nResponse Data
Response parameters expected in each affiliate permission object contained within the data field array:
Fetch a list of whitelist type affiliate permission objects associated with a platform user.
Response Data
Response parameters expected in each affiliate permission object contained within the data field array:
Fetch a list of blacklist type affiliate permission objects associated with a platform user.
Response Data
Response parameters expected in each affiliate permission object contained within the data field array:
Associate whitelist type affiliate permissions to a platform user.
Request Data
Request parameters expected during this API call:
Associate blacklist type affiliate permissions to a platform user.
Request Data
Request parameters expected during this API call:
Completely remove affiliate permissions from a platform user.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1"],"host":["{{app_key}}","{{domain}}{{v2_ext}}affiliate-permissions"],"query":[],"variable":[]}},"response":[],"_postman_id":"d51e8eeb-9af8-4381-8428-aa1d12846c61"}],"id":"94201a8b-f5f4-49fc-8f87-be3296a0fa95","description":"Associate platform users to affiliate permissions. Users can have grant or revoke access to affiliates. These permissions will be leveraged on several analytics dashboards.
Fetch a list of affiliate type objects.
\nResponse Data
Response parameters expected in each affiliate type object contained within the data field array:
Fetch a list of affiliates.
\nResponse Data
Response parameters expected in each affiliate object contained within the data field array:
Fetch a specific affiliate object by ID.
\nResponse Data
Response parameters expected in each affiliate object contained within the data field array:
Create a new affiliate.
\nRequest Data
Request parameters expected during this API call:
Update an existing affiliate.
\nRequest Data
Request parameters expected during this API call:
Delete an existing affiliate.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1"],"host":["{{app_key}}","{{domain}}{{v2_ext}}affiliates"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ce00e9a-c1d9-4496-b700-688125eb718d"}],"id":"485f6d28-10db-41fb-af96-10cc1f2fce3c","description":"Manage affiliate records and associate them to platform users. Users can be whitelisted or blacklisted to one or more affiliates.
\nAffiliate Access Types
These type IDs can be used when creating affiliate user permissions:
Fetch a list of billing model types.
\nResponse Data
Response parameters expected in each billing model object contained within the data field array:
Fetch a list of frequency types.
\nResponse Data
Response parameters expected in each frequency type object contained within the data field array:
Fetch the days of the week.
\nResponse Data
Response parameters expected in each day object contained within the data field array:
Fetch weeks in a month.
\nResponse Data
Response parameters expected in each week object contained within the data field array:
Below you will find methods to retrieve different IDs that are required when creating or updating Billing Model(s)
\n","_postman_id":"461871ae-a943-4f72-af2d-48356ec76590","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Get Billing Models","id":"114d31fa-6cae-47d3-b1fe-beb73e0d0b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}billing_models","description":"Fetch a list of saved billing models.
\nResponse Data
Response parameters expected in each billing model object contained within the data field array:
Create a billing model.
\nRequest Data
Request parameters expected during this API call:
Update a billing model.
\nRequest Data
Additional request parameters available after the billing model is created:
Below you will find methods related to Billing Models
\n","event":[{"listen":"prerequest","script":{"id":"25decbe7-57a0-4590-8237-ecc94209c258","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e88327d-9c14-40df-af9a-6a1b01263d85","type":"text/javascript","exec":[""]}}],"_postman_id":"5b958f11-5513-4664-9474-557b04568b93","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Campaigns ","item":[{"name":"Meta","item":[{"name":"Get Channels","id":"e224085d-97cd-486d-82d8-967513aaa68c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}campaigns/channels","description":"Fetch a list of channel objects.
\nResponse Data
Response parameters expected in each channel object contained within the data field array:
Fetch a list of campaign payment method objects.
\nResponse Data
Response parameters expected in each payment method object contained within the data field array:
Below you will find methods for IDs and other data needed to create or update a Campaign
\n","_postman_id":"a120441b-5e98-47a6-9dcd-1111fe6a7ed6","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Add Campaign","id":"df62171c-aa92-43ce-90fe-68e08f40181e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Campaign\",\r\n \"description\": \"This is my first campaign\",\r\n \"is_prepaid_blocked\": 1,\r\n \"channel_id\": 1,\r\n \"gateway_id\": 1,\r\n \"payment_methods\": [\r\n \"amex\",\r\n \"aura\",\r\n \"diners\",\r\n \"discover\"\r\n ],\r\n \"offers\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5\r\n ],\r\n \"countries\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5\r\n ],\r\n \"shipping_profiles\": [\r\n 2,\r\n 3,\r\n 4,\r\n 5,\r\n 6\r\n ],\r\n \"return_profiles\": [],\r\n \"coupon_profiles\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5\r\n ],\r\n \"postback_profiles\": [\r\n 1,\r\n 2,\r\n 3,\r\n 4,\r\n 5\r\n ]\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}campaigns","description":"Create a new campaign.
\nRequest Data
Request parameters expected during this API call:
Copy an existing campaign.
\nResponse Data
Response parameters expected within the data field object:
Fetch a specific campaign object by campaign ID.
\nResponse Data
Response parameters expected in data field object:
Fetch a list of campaign objects.
\nResponse Data
Response parameters expected in each campaign object contained within the data field array:
Update an existing campaign.
\nRequest Data
Request parameters expected during this API call:
Restore an archived campaign.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{campaign_id}}","restore"],"host":["{{app_key}}","{{domain}}{{v2_ext}}campaigns"],"query":[],"variable":[]}},"response":[{"id":"0271f933-b33c-4a92-a7d4-ecd0bb75673a","name":"Restore Campaign","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}campaigns/{{campaign_id}}/restore"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 24 Oct 2019 11:30:25 GMT"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"76305247-94ad-4580-ab8d-2b039d408321"},{"name":"Delete Campaign","id":"d03efc4f-d9cf-469a-806c-947780485348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}campaigns/{{campaign_id}}","description":"Delete an existing campaign.
\nNote
A campaign can not be deleted if products are attached
Below you will find methods related to Campaigns
\n","event":[{"listen":"prerequest","script":{"id":"ffa201d3-8a6f-4ac3-8b6b-a346d1c1bf3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a0bbbe30-3365-4e2b-a4f5-18a428cb6caf","type":"text/javascript","exec":[""]}}],"_postman_id":"1e4dea97-5b20-4c0a-903e-3aae77677568","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Contacts","item":[{"name":"Addresses","item":[{"name":"Get Countries","id":"244a117b-e004-45de-a371-a2b32801bb92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}countries","description":"Fetch a list of all countries
\nResponse Data
Response parameters expected in country object contained within the data field array:
Fetch a list of all states by the country ID
\nResponse Data
Response parameters expected in state object contained within the data field array:
Fetch a list of all addresses by the contact ID
\nResponse Data
Response parameters expected in address object contained within the data field array:
Create a new address by the customer ID
\nRequest Data
Request parameters expected during this API call:
Delete an existing address attached to the customer
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{contact_id}}","addresses","{{address_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}contacts"],"query":[],"variable":[]}},"response":[{"id":"908b9aa7-c7da-4888-9d27-bd8b2aaff6ed","name":"Delete Address","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/addresses/{{address_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 10 Jun 2019 18:07:26 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.38 (Amazon)"},{"key":"Set-Cookie","value":"token=trk3ka6b0jhpqqi47os7fofjn8; expires=Mon, 10-Jun-2019 19:22:29 GMT; Max-Age=4500; path=/; secure"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"a992ab41-9d3d-4150-83d4-6c2d74b2d730"},{"name":"Update Address","id":"328b60aa-2369-4f12-9570-29a464916b8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"new@email.com\",\n \"phone\": \"(639)470-8510\",\n \"street\": \"7422 Dare Dale Vista Rd\",\n \"street_2\":\"Unit 123\",\n \"city\": \"Hudsonton\",\n \"state\": \"CT\",\n \"zip\": \"00502\",\n \"country_id\": 223,\n \"first_name\": \"Delphina\",\n \"last_name\": \"Conns\",\n \"is_default\": 1\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/addresses/{{address_id}}","description":"Update an existing address by the contact and address IDs
\nRequest Data
Request parameters expected during this API call:
Fetch a specific address object by ID.
\nResponse Data
Response parameters expected in address object contained within the data field object:
Fetch a list of all payment method types
\nResponse Data
Response parameters expected in payment method type object contained within the data field array:
Fetch a list of all payment methods
\nResponse Data
Response parameters expected in payment method object contained within the data field array:
An index of Payment Types and Payment Methods. The permission for this method is based on GET to Contacts as that is the contect that this will be used
\n","event":[{"listen":"prerequest","script":{"id":"f3130676-e282-4502-b86a-a5e46c1ea4d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fcda07fb-6449-4e23-b37e-8408490d4979","type":"text/javascript","exec":[""]}}],"_postman_id":"a74c763c-c134-4d8e-9b5f-7ee7b1e7e2b3","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Create Contact Payment Source","id":"e09f3369-c4eb-44f0-8d88-e02c358f1e92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"alias\":\"My entry\",\n \"account_number\":\"4000094587032169\",\n \"expiry\":\"1125\",\n \"is_default\":1,\n \"payment_type_id\":1,\n \"address_id\":7\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/payment_sources","description":"Create a new payment source and attach it by customer ID
\nRequest Data
Request parameters expected during this API call:
Fetch a single payment source
\nResponse Data
Response parameters expected in payment method object contained within the data field object:
Update an existing payment source that by the customer ID
\nRequest Data
Request parameters expected during this API call:
Delete an existing payment source
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{contact_id}}","payment_sources","{{payment_source_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}contacts"],"query":[],"variable":[]}},"response":[{"id":"95c5e485-7cfc-41ad-91d2-64e56e7fa8b0","name":"Delete Contact Payment Source","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/payment_sources/{{payment_source_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 24 Jun 2019 14:25:39 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=2tt442pqte0k1m7p258oev1o2c; expires=Mon, 24-Jun-2019 15:40:42 GMT; Max-Age=4500; path=/; secure"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"a3c2a771-3d94-4808-90a6-5a02f3562deb"},{"name":"Get Contact Payment Sources","id":"a4c15851-b7b5-46eb-953e-80ed610e000b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/payment_sources","description":"Fetch a list of all payment sources by the customer ID
\nResponse Data
Response parameters expected in payment source object contained within the data field array:
Fetch a list of all interests to products by the customer ID
\nResponse Data
Response parameters expected in interest object contained within the data field array:
Create a contact interest to a product by Contact ID
\nRequest Data
Request parameters expected during this API call:
Enable SMS communications by the contact ID
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{contact_id}}","communications","sms","enable"],"host":["{{app_key}}","{{domain}}{{v2_ext}}contacts"],"query":[],"variable":[]}},"response":[],"_postman_id":"d347cfd8-fde3-4d85-b76f-3c58475d630e"},{"name":"Disable SMS Communication","id":"ff55f6e7-4af5-4f03-b76e-864a9e64cab7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts/{{contact_id}}/communications/sms/disable","description":"Disable SMS communications by the contact ID
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{contact_id}}","communications","sms","disable"],"host":["{{app_key}}","{{domain}}{{v2_ext}}contacts"],"query":[],"variable":[]}},"response":[],"_postman_id":"ff55f6e7-4af5-4f03-b76e-864a9e64cab7"}],"id":"ff3ae301-e651-4e1a-9463-2e3fe04b454e","event":[{"listen":"prerequest","script":{"id":"3b44a008-3332-42b9-9bb7-f10ad3eebe10","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b9ee5a28-ac50-4a29-81c5-40b8342fe621","type":"text/javascript","exec":[""]}}],"_postman_id":"ff3ae301-e651-4e1a-9463-2e3fe04b454e","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Get Contacts","id":"4bac8f47-3998-4190-b7d8-e2302b737d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}contacts?search[created_at]={\"start\": \"2018-12-07\", \"end\":\"2018-12-07\"}","description":"Fetch a list of all contacts
\nResponse Data
Response parameters expected in contact object contained within the data field array:
Fetch a list of all coupon types
\nResponse Data
Response parameters expected in coupon type object contained within the data field array:
Fetch a list of all coupon discount types
\nResponse Data
Response parameters expected in coupon discount type object contained within the data field array:
Fetch a list of all coupon discount behavior types
\nResponse Data
Response parameters expected in coupon discount behavior type object contained within the data field array:
Fetch a list of all promo codes
\nResponse Data
Response parameters expected in promo code object contained within the data field array:
Fetch a list of all promo codes attached to the coupon profile ID
\nResponse Data
Response parameters expected in promo code object contained within the data field array:
Create a promo code
\nIn this api you will receive an \"id\" in the response and then use this \"id\" in request data of \"Update Coupon Profile\" Api to add it into respective coupon profile.
\nRequest Data
Request parameters expected during this API call:
Delete an existing promo code.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["promo_codes","{{promo_code_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}coupons"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f8fbc1c-15ac-4d79-823e-d0d0a87cf309"}],"id":"a62b56f7-9dda-41fd-b573-e650e0928569","_postman_id":"a62b56f7-9dda-41fd-b573-e650e0928569","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Get Coupon Profiles","id":"fcf2a7d6-bc0a-4281-b48e-4289e8a71606","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}coupons","description":"Fetch a list of all coupon profiles
\nResponse Data
Response parameters expected in coupon profile object contained within the data field array:
Create a new coupon profile. For the promo_codes array, you make either pass an id of an existing promo code or you can pass the code and a new promo code will be generated. For meta data like type_id and the like, see the Coupon / Meta folder
Request Data
Request parameters expected during this API call:
Fetch a single coupon profile
\nResponse Data
Response parameters expected in coupon profile object contained within the data field object:
Update an existing coupon profile. For the promo_codes array, you make either pass an id of an existing promo code or you can pass the code and a new promo code will be generated. For meta data like type_id and the like, see the Coupon Meta folder. For payload examples, see the Create Coupon Profile method
Request Data
Request parameters expected during this API call:
Delete an existing coupon profile
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{coupon_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}coupons"],"query":[],"variable":[]}},"response":[],"_postman_id":"8cfd35b4-75bc-4ede-8269-99cb38882757"},{"name":"Delete Order Coupon","id":"1ae52dbe-eff7-494c-9221-48b5dfe04dc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/13539/coupon","description":"Remove the coupon from the next recurring order.
\nTo be eligible for coupon removal from the next recurring order, an order must meet the following conditions:
\nOrder Status: The order must not be pending, deleted, or on hold.
\nRecurring Status: The order must be recurring-enabled, with a non-empty recurring date.
\nCoupon Status: A coupon must be currently applied to the order.
\nIf the provided order meets these criteria, the coupon can be removed for the next recurring order in the subscription.
\nParameters:
\n{{order_id}}: Replace this placeholder with the specific order ID or use an applicable child order ID that has a coupon applied and is pending recurrence.The coupon will be removed for the next recurring order in the subscription chain.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["13539","coupon"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ae52dbe-eff7-494c-9221-48b5dfe04dc2"}],"id":"a39871fc-b4e3-4ae9-a4c9-97c27b2be825","event":[{"listen":"prerequest","script":{"id":"5876e287-138d-49d8-8a9d-dc00eb09044b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dd3d8d59-d53b-4ba7-abca-9d023ab77b1b","type":"text/javascript","exec":[""]}}],"_postman_id":"a39871fc-b4e3-4ae9-a4c9-97c27b2be825","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Custom Fields","item":[{"name":"Get All Custom Fields","id":"187dc7a7-1c5d-430e-b793-4913c54c8dd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}custom_fields","description":"Fetch a list of all custom fields
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
Fetch a single coupon profile
\nResponse Data
Response parameters expected in custom field object contained within the data field object:
Update an existing custom field.
\nRequest Data
Request parameters expected during this API call:
Create a new custom field
\nRequest Data
Request parameters expected during this API call:
Fetch a list of all custom field's types
\nResponse Data
Response parameters expected in custom field's type object contained within the data field array:
Fetch a list of all custom field's field types
\nResponse Data
Response parameters expected in custom field's field type object contained within the data field array:
Fetch a list of all options attached to requested custom field ID
\nResponse Data
Response parameters expected in custom field's field type object contained within the data field array:
Add an option to an existing custom field's option list.
\nRequest Data
Request parameters expected during this API call:
Delete an existing custom field
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0","id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0","name":"Custom Fields","type":"folder"}},"urlObject":{"protocol":"https","path":["{{custom_field_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}custom_fields"],"query":[],"variable":[]}},"response":[],"_postman_id":"d168ef02-5444-4ad6-afb4-1feb7cfe00d9"},{"name":"Delete Option From Custom Field","id":"da991a6e-5403-48b0-b6f0-a4f3c08ab759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}custom_fields/{{custom_field_id}}/options/{{option_id}}","description":"Delete an existing option from custom field's option list
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0","id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0","name":"Custom Fields","type":"folder"}},"urlObject":{"protocol":"https","path":["{{custom_field_id}}","options","{{option_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}custom_fields"],"query":[],"variable":[]}},"response":[],"_postman_id":"da991a6e-5403-48b0-b6f0-a4f3c08ab759"}],"id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0","description":"Custom Fields are available for the following Types:
\nAn example request to add a Custom Field Value can be found in the section for the respective Type
\nPLEASE NOTE\nThe maximum number of Custom Fields per type is 250.\nThe maximum number of Options that can be attached to a Custom Field is 250\nThe maximum number of Custom Field Values that can be attached per Type ID is 250
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d59a3b9e-3278-458e-a788-b81d12e06f90","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"baec0bb6-34d5-456b-9001-a9c1bb9050b3","type":"text/javascript","exec":[""]}}],"_postman_id":"7bfb3b59-c800-4a9f-af6b-ce892c8c9ba0"},{"name":"Customers","item":[{"name":"Get Customer Custom Fields","id":"55bdc723-17b3-4c88-a228-caf4be8bebd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}custom_fields/customers","description":"Fetch a list of all custom fields created for customers
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
Attach an existing customer's custom fields and assign values for them to the customer.
\nRequest Data
Request parameters expected during this API call:
Update custom fields list that attached to the customer.
\nRequest Data
Request parameters expected during this API call:
Delete an existing custom field from the list attached to the customer
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{customer_id}}","custom_fields","{{custom_field_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}customers"],"query":[],"variable":[]}},"response":[{"id":"4651d1b7-c3b9-428d-8030-962c50434094","name":"Delete Custom Field Values","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}customers/{{customer_id}}/custom_fields/{{custom_field_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 07 Nov 2018 12:44:59 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"777efe1d-5010-488e-8885-8c6a51fbf632"},{"name":"Get Customer Interests","id":"659048fe-55ba-4539-8910-1a673f2f4364","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}customers/{{customer_id}}/interests","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{customer_id}}","interests"],"host":["{{app_key}}","{{domain}}{{v2_ext}}customers"],"query":[],"variable":[]}},"response":[],"_postman_id":"659048fe-55ba-4539-8910-1a673f2f4364"},{"name":"Get Customer Subscriptions","id":"ca36ba2d-595d-49f9-9318-adfeb17bc366","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}customers/{{customer_id}}/subscriptions?search[is_recurring]=1&search[is_archived]=0&search[is_hold]=0&search[recur_at]={\"start\": \"2021-06-05, \"end\": \"2021-06-06\"}&search[next_product_id]=1&search[billing_model_id]=7","description":"This method is used to get subscriptions for a given customer using the customer_id.
\nMax Requests Per Minute: 120
\nThis method is used to update an existing customer record that match an ID provided in the API endpoint.
\nThese fields values of a customer record can be updated with this API.
'dob', 'gender', 'first_name', 'last_name', 'nick_name', 'email', 'phone', 'tax_exemption', 'custom_fields'
In response you will get: A status of request for customer pre-defined fields and a status of custom fields along with customer and custom fields object.
\nSee the reqeuest parameters definition for customer record update.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{customer_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}customers"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fcb0345-c214-4a72-bc01-913ba819577f"}],"id":"01c73db9-cd46-40d5-974d-2251f1c17ccb","_postman_id":"01c73db9-cd46-40d5-974d-2251f1c17ccb","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Gateways","item":[{"name":"Get Accounts","id":"45ac49c9-6b74-4d22-b78d-bf0ef48a0aeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}providers/payment","description":"Fetch all the payments providers.
\nResponse Data
Response parameters expected in the object contained within the data field array:
Fetch all the fields for the given payment gateway.
\nResponse Data
Response parameters expected in the object contained within the data field array:
Fetch a list of Profile objects for the given account ID.
\nResponse Data
Response parameters expected in each Provider object contained within the data field array:
Fetch a Profile object by ID.
\nResponse Data
Response parameters expected in the Profile object contained within the data field object:
Create a profile for the given payment provider. The correct payment provider ID for the URI can be found using the Get Accounts endpoint.
\nRequest Data
Request parameters expected during this API call:
Response Data
The created Profile, response parameters expected in the object contained within the data field object:
Update the given Profile.
\nRequest Data
Request parameters expected during this API call:
Response Data
The updated Profile, response parameters expected in the object contained within the data field object:
Creates a new Image, it expects a file for image, if you want to use an URL see \nPOST Create Image method
Creates a new Image, it expects an URL for image, if you want to upload the file see \nPOST Upload Image method
The image URL
\n","type":"text/plain"},"key":"image","value":"https://pbs.twimg.com/profile_images/1216813945408966663/vkVajfRz_400x400.jpg"},{"description":{"content":"The image alias
\n","type":"text/plain"},"key":"alias","value":"google-logo"}],"variable":[]}},"response":[],"_postman_id":"2a7542a5-dad9-4397-b821-1ffe573db18f"},{"name":"List Images","id":"1b9290e5-f749-4614-a637-6488e1ca4447","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}images?search[updated_at]=<::2021-09-05","description":"Fetch all the images for the given parameters (all if none supplied)
\nResponse Data
Response parameters expected in the object contained within the data field array:
Fetch the image for the given id or uuid
\nResponse Data
Response parameters expected in the object contained within the data field object:
Attach an existing orders' custom fields and assign values for them to the order.
\nRequest Data
Request parameters expected during this API call:
Update custom fields list that attached to the order.
\nRequest Data
Request parameters expected during this API call:
Delete an existing custom field from the list attached to the order
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{order_id}}","custom_fields","{{custom_field_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[{"id":"3040e8a8-7f4d-4d6a-956f-41ba82e6133e","name":"Delete Custom Field Values","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/custom_fields/{{custom_field_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 07 Nov 2018 12:56:32 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"46041f85-1d29-417d-81ea-886771c3c34d"},{"name":"Get Order Custom Fields","id":"a2e1dc3b-9b12-482d-859e-b4df1313770f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}custom_fields/orders","description":"Fetch a list of all custom fields created for orders
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
A method to GET the different History Note Types.
\nResponse Data
Response parameters expected in each history note type object contained within the data field array:
A method to GET the different History Note Template Types.
\nResponse Data
Response parameters expected in each history note template object contained within the data field array:
A method to GET available Cancellation Type Note Templates.
\nResponse Data
Response parameters expected in each Cancellation Type Note Templates object contained within the data field array:
A method to GET available Default Type Note Templates.
\nResponse Data
Response parameters expected in each Default Type Note Templates object contained within the data field array:
A method to GET available Refund Type Note Templates.
\nResponse Data
Response parameters expected in each Refund Type Note Templates object contained within the data field array:
A method to GET available Restart / Reset Subscription Type Note Templates
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["histories","notes","templates","restart_reset_subscription"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"8449d08a-ac78-4713-b405-94d0f78555ab"},{"name":"GET Subscription Credit Note Templates","id":"652cbfc1-cff0-48cd-b0a4-82f4913a0b53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/histories/notes/templates/subscription_credit","description":"A method to GET available Subscription Credit Type Note Templates.
\nResponse Data
Response parameters expected in each Subscription Credit Type Note Templates object contained within the data field array:
Query method to GET history notes added between a given period of time. MAX time is 30 days. Results will be paginated.
\nResponse Data
Response parameters expected in each History Note object contained within the data field array:
Retrieve all history notes for a given Order ID. Results will be paginated.
\nResponse Data
Response parameters expected in each History Note object contained within the data field array:
Starts a new subscription for the given order subscription ID.
\nResponse Data
Response parameters expected in object contained within the data field object:
Stops a subscription for the given order subscription ID.
\nRequest Data
Request parameters expected during this API call:
Resets a subscription for the given order subscription ID.
\nResponse Data
Response parameters expected in object contained within the data field object:
Stops subscription for the given order subscription ID in the next successful period.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","terminate_next"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"c020ec6b-6409-4fef-9c02-d03442681909","name":"Stop On Next Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/terminate_next"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 15 Nov 2019 18:17:59 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"31c60506-fc6f-41cf-b821-b8d07f6026c9"},{"name":"Destroy Stop On Next Success","id":"c411b1ee-e502-4f8b-af08-1a27857a3271","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/terminate_next","description":"Destroy the stop subscription for the given order subscription ID in the next successful period condition.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","terminate_next"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"6e85da8a-0103-4155-a3f1-8e0aba9efed1","name":"Destroy Stop On Next Success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/terminate_next"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 15 Nov 2019 18:18:15 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"c411b1ee-e502-4f8b-af08-1a27857a3271"}],"id":"f4971ecf-2d15-4deb-b8b3-1c85d5990b98","_postman_id":"f4971ecf-2d15-4deb-b8b3-1c85d5990b98","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Products","item":[{"name":"Change Recurring Product","id":"88f8b810-4b51-4b71-a71c-41b33bdc0faa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product_id\":9,\n \"children\":[\n \t{\n \t\t\"product_id\":12,\n \t\t\"quantity\":1\n \t},\n\t{\n \t\t\"product_id\":13,\n \t\t\"quantity\":2\n \t}\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/product","description":"Changes the recurring parameters for a recurring product.
\nRequest Data
Request parameters expected during this API call:
Get options for next recurring product.
\nResponse Data
Response parameters expected in each trial workflow object contained within the data field array:
Get billing model options for a subscription.
\nResponse Data
Response parameters expected in each trial workflow object contained within the data field array:
|\n| creator.id | Integer | The user active status.\n |\n| creator.is_active | Boolean | The admin user active status. |\n| creator.name | String | The user name. |\n| creator.email | String | The user email. |\n| creator.call_center_provider_id | Integer | The call center provider ID associated with the user. |\n| updator | Object | Object that contains data pertaining to the user that updated the Billing Model. |\n| updator.department_id | Integer | Department ID associated with the admin user. |\n| updator.timezone | String | The admin user timezone.\n |\n| updator.id | Integer | The user active status.\n |\n| updator.is_active | Boolean | The admin user active status. |\n| updator.name | String | The user name. |\n| updator.email | String | The user email. |\n| updator.call_center_provider_id | Integer | The call center provider ID associated with the user. |
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","billing_models"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"6462f0a9-b176-4843-abce-d79421e37a4d","name":"Get Available Billing Models","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/billing_models"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 13:00:44 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=m0injajrsief3rrb42qqls5gu3; expires=Tue, 15-Oct-2019 14:15:47 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"3748"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Straight Sale\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 14:31:18.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": null,\n \"is_preserve_quantity\": 0,\n \"type\": {\n \"id\": 0,\n \"name\": \"Straight Sale\"\n },\n \"creator\": {\n \"department_id\": 0,\n \"id\": 999998,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM API\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": null\n },\n {\n \"id\": 3,\n \"name\": \"Every 7 Days\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:14:41.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:30:09.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_preserve_quantity\": 1,\n \"type\": {\n \"id\": 1,\n \"name\": \"Bill by cycle\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n },\n {\n \"id\": 4,\n \"name\": \"First of Every Month\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:14:51.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:30:55.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_preserve_quantity\": 1,\n \"type\": {\n \"id\": 2,\n \"name\": \"Bill by date\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n },\n {\n \"id\": 5,\n \"name\": \"First Sunday\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:15:01.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:31:22.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_preserve_quantity\": 1,\n \"type\": {\n \"id\": 3,\n \"name\": \"Bill by day\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n },\n {\n \"id\": 6,\n \"name\": \"Quarterly 15th\",\n \"buffer_days\": 5,\n \"created_at\": {\n \"date\": \"2019-04-29 15:15:14.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": null,\n \"is_preserve_quantity\": 1,\n \"type\": {\n \"id\": 4,\n \"name\": \"Bill by schedule\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": null\n },\n {\n \"id\": 7,\n \"name\": \"Monthly\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:15:24.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:36:28.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_preserve_quantity\": 1,\n \"type\": {\n \"id\": 5,\n \"name\": \"Bill by relative date\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n },\n {\n \"id\": 8,\n \"name\": \"Bi-Weekly\",\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:33:58.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:36:56.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_preserve_quantity\": 0,\n \"type\": {\n \"id\": 1,\n \"name\": \"Bill by cycle\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n }\n ]\n}"},{"id":"913dc724-ab44-43d8-86de-d78429ed4f15","name":"Get Available Billing Models NUTRA","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/billing_models"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 13:01:39 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=m0injajrsief3rrb42qqls5gu3; expires=Tue, 15-Oct-2019 14:16:42 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16052,\n \"message\": \"Subscription was not placed using billing models and offers\"\n}"},{"id":"f4198d02-afb3-4b1d-8008-9918213da067","name":"Get Available Billing Models Invalid Subscription ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/billing_models"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 13:02:28 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=m0injajrsief3rrb42qqls5gu3; expires=Tue, 15-Oct-2019 14:17:31 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"69"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16008,\n \"message\": \"Invalid Subscription ID\"\n}"}],"_postman_id":"1f4dd187-0035-4bfb-a11c-1378d638b3ad"},{"name":"Update Billing Model","id":"53a35c9f-c039-47b3-8b6f-b4cde09f4443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"billing_model_id\": 5\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/billing_model","description":"Updates the billing model for the order subscription ID.
\nRequest Data
Request parameters expected during this API call:
Updates the discount for the given order subscription ID.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","discount"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"31e1e965-9df1-44ee-9a22-e1dd14e749d1","name":"Remove Next Coupon/Promo Code","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"SUCCESS\"\r\n}"},{"id":"360f36c8-a861-44d9-b2d1-35ba1db13158","name":"Add / Update Discount No Parameters","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:06:46 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:21:50 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"92"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16053,\n \"message\": \"Discount amount OR percent required - not both\"\n}"},{"id":"3671ad72-199f-467b-a455-a2edec1b1fe9","name":"Add / Update Discount Amount","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5.95\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:18:41 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:33:44 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"4be33ee6-9108-417f-80b8-644b02573e34","name":"Add / Update Discount Amount And Percent","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 100,\n \"percent\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:06:22 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:21:27 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"92"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16053,\n \"message\": \"Discount amount OR percent required - not both\"\n}"},{"id":"786d22cd-712b-4fcf-a90b-d1ff2af055d7","name":"Add / Update Discount Percent Too High","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"percent\": 101\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:07:27 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:22:32 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"112"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Request\",\n \"data\": {\n \"percent\": [\n \"The percent may not be greater than 100.\"\n ]\n }\n}"},{"id":"7b91b983-cea8-40c7-b921-45022f987f60","name":"Add / Update Discount Not Placed With Billing Models / Offers","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 5.95\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:19:23 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:34:26 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16052,\n \"message\": \"Subscription was not placed using billing models and offers\"\n}"},{"id":"ce9542b0-e862-4311-bf2b-1c379e10e410","name":"Add / Update Discount Percent","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"percent\": 5\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:17:32 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:32:36 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"d8bca12e-6dae-4d01-b789-d1935a7adb73","name":"Add / Update Discount Next Coupon/Promo Code","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"100OFF\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 23 Feb 2021 00:19:15 GMT"},{"key":"Server","value":"Apache/2.4.46 ()"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"e46a79e1-49ef-4a85-b143-3bf6d3cdef0a","name":"Set Next Coupon/Promo Code","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"code\": \"100OFF\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"SUCCESS\"\r\n}"}],"_postman_id":"2d19e2ae-1e1d-4a37-8967-2630554520a6"},{"name":"Destroy Discount","id":"3ff7200e-161b-4091-9e00-77b715002e02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount","description":"Delete the discount for the given order subscription ID.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","discount"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"198a7dc7-2899-4c5d-87fe-3b23eabcedb3","name":"Destroy Discount","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:43:02 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:58:02 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"9d18cffe-b567-4957-a284-10573f68bbc5","name":"Destroy Discount No Placed With Billing Models / Offers","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/discount"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 15 Oct 2019 18:42:21 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=p7mm1drf7a8ac6map77vv282sp; expires=Tue, 15-Oct-2019 19:57:21 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"105"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16052,\n \"message\": \"Subscription was not placed using billing models and offers\"\n}"}],"_postman_id":"3ff7200e-161b-4091-9e00-77b715002e02"}],"id":"710b4622-a992-41ae-bbfc-5ff1f8a13c73","event":[{"listen":"prerequest","script":{"id":"17532578-8399-443b-b651-b93e2e513211","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab951226-7ab3-4091-84e1-f93330621f4a","type":"text/javascript","exec":[""]}}],"_postman_id":"710b4622-a992-41ae-bbfc-5ff1f8a13c73","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Credits","item":[{"name":"Create / Update Subscription Credit","id":"9dd974e2-cd96-4238-9583-cafc340a4295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": \"100\",\n \"action\": \"replace\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits","description":"This will be used to either create or update a subscription credit.
\naction is an additional parameter that can be passed in the request. when the action is replace the amount that is passed in the request will be the amount that is now a credit on the subscription. If it is not passed, and there is already a credit on the subscription, the amount passed will be ADDED to the subscription
Remove a subscription credit
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","credits"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"165d1056-9770-4ec8-be75-0bc408c8111c","name":"Delete Subscription Credit","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Fri, 04 Oct 2019 17:17:26 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=02brutks9h8e2ucc3gji1l9p67; expires=Fri, 04-Oct-2019 18:32:29 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"bbec0db8-dd36-46ce-bac4-7551a201d4b4","name":"Invalid Subscripition ID","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 11:25:37 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=5adef8gth0es7fnam5qhf7vh5j; expires=Tue, 08-Oct-2019 12:40:40 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Subscription ID\"\n}"}],"_postman_id":"b8112dd9-a315-4a2c-9df2-75a8dc38591f"},{"name":"Get Subscription Credit","id":"a2c44220-c893-421d-8bfd-12803f0604c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits","description":"View the details of a subscription credit
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","credits"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"7e071103-a965-488d-bbf2-2a2ee4f41946","name":"Get Subscription Credit","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 11:22:43 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=5adef8gth0es7fnam5qhf7vh5j; expires=Tue, 08-Oct-2019 12:37:46 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"483"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"item_id\": \"66df563e89dfb6dd5b58be77db025158\",\n \"amount\": \"225.0000\",\n \"created_at\": \"2019-10-07 13:54:37\",\n \"updated_at\": \"2019-10-08 07:22:23\",\n \"type\": {\n \"id\": 1,\n \"name\": \"Susbcription\"\n },\n \"creator\": {\n \"department_id\": 0,\n \"id\": 999999,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n }\n}"},{"id":"f104c29a-0fd4-4c90-8a46-ad7e9ea48d04","name":"Invalid Subscription ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/credits"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 11:25:10 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=5adef8gth0es7fnam5qhf7vh5j; expires=Tue, 08-Oct-2019 12:40:13 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Subscription ID\"\n}"}],"_postman_id":"a2c44220-c893-421d-8bfd-12803f0604c1"},{"name":"Issue Subscription Credit","id":"119436d6-6dc4-492a-96e0-047e7b7ea8dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credit_amount\": 15,\n \"credit_action\": \"replace\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/credit","description":"Adds or replace credit to an order.\ncredit_action parameter is optional. If passed and equals 'replace' the credit gets replaced, else the credit gets added to the existing credit.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{order_id}}","credit"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"119436d6-6dc4-492a-96e0-047e7b7ea8dd"},{"name":"Destroy Subscription Credit","id":"8ee32c20-5078-48fc-828a-09d770b384e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/credit","description":"Remove credit of an order.
\n","urlObject":{"protocol":"https","path":["{{order_id}}","credit"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ee32c20-5078-48fc-828a-09d770b384e3"}],"id":"c904f680-9c46-4c53-a3ce-b8deba489c9a","event":[{"listen":"prerequest","script":{"id":"9d50a9b4-a04f-4ffb-ad9b-cf8b4ca763eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"595e81ca-0abb-4d41-9fc4-a9429b9a9dec","type":"text/javascript","exec":[""]}}],"_postman_id":"c904f680-9c46-4c53-a3ce-b8deba489c9a","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Overrides","item":[{"name":"Create Subscription Override","id":"9a6239b6-ff2d-4251-8f25-e692cdb14570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"conten","value":"application/json","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address_id\": 1,\n \"contact_payment_source_id\": 1\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/override","description":"This will create a subscription override when a specific product line item when passing the subscription id
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","override"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"9a6239b6-ff2d-4251-8f25-e692cdb14570"},{"name":"Delete Subscription Override","id":"1f983fe3-f08a-43a3-b40e-4d2c0af4963d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/override","description":"This is to delete a subscription override for a specific line item if a subscription id is passed.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","override"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f983fe3-f08a-43a3-b40e-4d2c0af4963d"},{"name":"Update Subscription Override","id":"95e82e7b-28bd-4ce6-9f1a-dd2e0aadd122","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"address_id\": 2\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/override","description":"This subscription override will have the capability of updating a specific line item via passing the subscription id.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","override"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"95e82e7b-28bd-4ce6-9f1a-dd2e0aadd122"},{"name":"Get Subscription Override","id":"2e71af8e-9310-45c8-8e3c-78433e9aff78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/override","description":"This route allows the user to see the subscription override for a specific line item when the subscription_id is passed.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","override"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e71af8e-9310-45c8-8e3c-78433e9aff78"},{"name":"Set Subscription Address Override","id":"cf47637e-e019-4e31-ba4b-58416e4089e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"street\": \"560 W. Main\",\n \"city\": \"Chicago\",\n \"state\": \"IL\",\n \"zip\": 12345,\n \"country\": \"US\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/override/address","description":"This is an idempotent operation that will set (create or update) the 'Address Override' for the subscription in question.
\nIf the given address already exists in the system, the existing record will be referenced, otherwise it will be created.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","override","address"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf47637e-e019-4e31-ba4b-58416e4089e6"}],"id":"ddded6a5-c0b7-474a-9df5-328ba8fca4ce","event":[{"listen":"prerequest","script":{"id":"d340a4a0-2c1f-41c0-a72d-558959b24134","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2b32511b-f170-4e87-8e38-fe821dc5b04b","type":"text/javascript","exec":[""]}}],"_postman_id":"ddded6a5-c0b7-474a-9df5-328ba8fca4ce","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Line Item Custom Options","item":[{"name":"Get Line Item Custom Options","id":"cb634a4c-e52c-4a99-b59d-0cdab5b2baf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/line-item-options?order_id=1","description":"Fetch a list of line item custom items associated with a subscription ID. If order ID is not passed, then the platform will select the latest order associated with the subscription.\\
\nRequest Data
URL Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Optional parameter that represents the order ID associated with the subscription ID provided in the URL.
\n","type":"text/plain"},"key":"order_id","value":"1"}],"variable":[]}},"response":[],"_postman_id":"cb634a4c-e52c-4a99-b59d-0cdab5b2baf5"},{"name":"Create/Update Line Item Custom Options","id":"ca5955ab-7e2c-4910-bae4-9d5039ba832d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\":26393,\n \"options\" : [\n {\n \"name\": \"x_key\", \n \"value\": \"3hdgcte83jdhac\"\n },\n {\n \"id\": 1, \n \"name\": \"y_key\", \n \"value\": \"dwsds7987dsfd\"\n }\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/line-item-options","description":"Create or update line item custom options associated with a subscription ID. If order_id is not passed, then the platform will select the latest order on the subscription.
Request Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Delete a line item custom option associated with a subscription ID. If order_id is not passed, then the platform will select the latest order on the subscription.
\nRequest Data
Request parameters expected during this API call:
Filter LineItemCustomOptions by any combination of the the following fields:\nname\nvalue\nsubscription_id\norder_id
Update the next recurring date for one or more line items in a subscription.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples\\
\nUpdate next recurring date by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29229,\n \"date\": \"2021-12-10\"\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"40d5282d19e4a6f9a9ac2e0e7113e683\",\n \"ce6f12061175ea4cb86dd2a23feebd8c\"\n ],\n \"update_type\": \"Next Recurring Date\",\n \"new_value\": \"2021-12-10\"\n }\n}\nUpdate next recurring date by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"ce6f12061175ea4cb86dd2a23feebd8c\",\n \"date\": \"2021-12-15\"\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"ce6f12061175ea4cb86dd2a23feebd8c\"\n ],\n \"update_type\": \"Next Recurring Date\",\n \"new_value\": \"2021-12-15\"\n }\n}\nUpdate next recurring date by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29229,\n \"product_id\": 24,\n \"date\": \"2021-12-09\"\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"ce6f12061175ea4cb86dd2a23feebd8c\"\n ],\n \"update_type\": \"Next Recurring Date\",\n \"new_value\": \"2021-12-09\"\n }\n}\nUpdate next recurring date by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29219,\n \"variant_id\": 6,\n \"date\": \"2021-12-21\"\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"640122fc14de0cb059572861346b8ab6\"\n ],\n \"update_type\": \"Next Recurring Date\",\n \"new_value\": \"2021-12-21\"\n }\n}\nUpdate the next recurring product/variant for one or more line items in a subscription.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples
\nUpdate next recurring product by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29224,\n \"next_recurring_product\": 6\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"d22895bf2943830a8be8988d0e076c3f\",\n \"b59d473387b5b4fc64a95da5f240510c\",\n \"6cce0566e9fdfd06a1e6ce43383ce20c\"\n ],\n \"update_type\": \"Next Recurring Product\",\n \"new_value\": \"6\"\n }\n}\nUpdate next recurring product by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"b59d473387b5b4fc64a95da5f240510c\",\n \"next_recurring_product\": 5\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"b59d473387b5b4fc64a95da5f240510c\"\n ],\n \"update_type\": \"Next Recurring Product\",\n \"new_value\": \"5\"\n }\n}\nUpdate next recurring product by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29224,\n \"product_id\": 11,\n \"next_recurring_product\": 5\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6cce0566e9fdfd06a1e6ce43383ce20c\"\n ],\n \"update_type\": \"Next Recurring Product\",\n \"new_value\": \"5\"\n }\n}\nUpdate next recurring product by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29219,\n \"variant_id\": 2,\n \"next_recurring_product\": 5\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"62fbc8e17931e03963151316e9c5b4ee\"\n ],\n \"update_type\": \"Next Recurring Product\",\n \"new_value\": \"5\"\n }\n}\nUpdate next recurring variant by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29219,\n \"next_recurring_variant\": 6\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"62fbc8e17931e03963151316e9c5b4ee\",\n \"640122fc14de0cb059572861346b8ab6\"\n ],\n \"update_type\": \"Next Recurring Variant\",\n \"new_value\": \"6\"\n }\n}\nUpdate next recurring variant by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"62fbc8e17931e03963151316e9c5b4ee\",\n \"next_recurring_variant\": 2\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"62fbc8e17931e03963151316e9c5b4ee\"\n ],\n \"update_type\": \"Next Recurring Variant\",\n \"new_value\": \"2\"\n }\n}\nUpdate next recurring variant by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29219,\n \"product_id\": 12,\n \"next_recurring_variant\": 6\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"62fbc8e17931e03963151316e9c5b4ee\",\n \"640122fc14de0cb059572861346b8ab6\"\n ],\n \"update_type\": \"Next Recurring Variant\",\n \"new_value\": \"6\"\n }\n}\nUpdate next recurring variant by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29219,\n \"variant_id\": 6,\n \"next_recurring_variant\": 2\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"640122fc14de0cb059572861346b8ab6\"\n ],\n \"update_type\": \"Next Recurring Variant\",\n \"new_value\": \"2\"\n }\n}\nUpdate the next recurring quantity for one or more line items in a subscription.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples
\nUpdate next recurring quantity by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29242,\n \"next_recurring_quantity\": 2\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"846c3fab798172978c11ea68684f83d4\",\n \"b6f2caf04da2f3dc89bbfc47bd4d076e\"\n ],\n \"update_type\": \"Next Recurring Quantity\",\n \"new_value\": \"2\"\n }\n}\nUpdate next recurring quantity by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"b6f2caf04da2f3dc89bbfc47bd4d076e\",\n \"next_recurring_quantity\": 3\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"b6f2caf04da2f3dc89bbfc47bd4d076e\"\n ],\n \"update_type\": \"Next Recurring Quantity\",\n \"new_value\": \"3\"\n }\n}\nUpdate next recurring quantity by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29242,\n \"product_id\": 7,\n \"next_recurring_quantity\": 4\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"b6f2caf04da2f3dc89bbfc47bd4d076e\"\n ],\n \"update_type\": \"Next Recurring Quantity\",\n \"new_value\": \"4\"\n }\n}\nUpdate next recurring quantity by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29249,\n \"variant_id\": 6,\n \"next_recurring_quantity\": 3\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Next Recurring Quantity\",\n \"new_value\": \"3\"\n }\n}\nUpdate the recurring billing model for one or more line items in a subscription.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples
\nUpdate the recurring billing model by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29257,\n \"billing_model_id\": 127\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"b50753ed2f30cdb3c98d25f1b0b29772\",\n \"a48ffbe6cb2f9609ab3bd1a41fdada4c\"\n ],\n \"update_type\": \"Billing Model\",\n \"new_value\": \"127\"\n }\n}\nUpdate the recurring billing model by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"a48ffbe6cb2f9609ab3bd1a41fdada4c\",\n \"billing_model_id\": 102\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"a48ffbe6cb2f9609ab3bd1a41fdada4c\"\n ],\n \"update_type\": \"Billing Model\",\n \"new_value\": \"102\"\n }\n}\nUpdate the recurring billing model by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29249,\n \"product_id\": 12,\n \"billing_model_id\": 102\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\",\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Billing Model\",\n \"new_value\": \"102\"\n }\n}\nUpdate the recurring billing model by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29249,\n \"variant_id\": 6,\n \"billing_model_id\": 124\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Billing Model\",\n \"new_value\": \"124\"\n }\n}\nUpdate the next recurring price for one or more line items in a subscription. Preservation will be defaulted to ON when is_preserve is not passed.
Request Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples
\nUpdate the next recurring price by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29249,\n \"price\": 12.99\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\",\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Next Recurring Price\",\n \"new_value\": \"12.99\"\n }\n}\nUpdate the next recurring price by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"225c0c4f0948f4ee7ba86b481580dd76\",\n \"price\": 13.98\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Next Recurring Price\",\n \"new_value\": \"13.98\"\n }\n}\nUpdate the next recurring price by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29249,\n \"product_id\": 12,\n \"price\": 2.99\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\",\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Next Recurring Price\",\n \"new_value\": \"2.99\"\n }\n}\nUpdate the next recurring price by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29249,\n \"variant_id\": 6,\n \"price\": 12.99\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Next Recurring Price\",\n \"new_value\": \"12.99\"\n }\n}\nUpdate the next recurring price preservation for one or more line items in a subscription. If set to 0, then any custom next recurring prices will not take effect upon rebill.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters expected in each line item custom option object contained within the data field array:
Examples
\nUpdate the next recurring price preservation by order ID only. This will update all line items in the order:
\nRequest\n{\n \"order_id\": 29249,\n \"is_preserve\": 1\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\",\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Recurring Price Preservation\",\n \"new_value\": \"1\"\n }\n}\nUpdate the next recurring price preservation by subscription ID only. This will update the line item that matches the subscription_id parameter:
Request\n{\n \"subscription_id\": \"6eb4e8c959330f52c81982cf83474404\",\n \"is_preserve\": 0\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\"\n ],\n \"update_type\": \"Recurring Price Preservation\",\n \"new_value\": \"0\"\n }\n}\nUpdate the next recurring price preservation by Order ID + Product ID. This will the target line items that match the product_id parameter:
Request\n{\n \"order_id\": 29249,\n \"product_id\": 12,\n \"is_preserve\": 1\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"6eb4e8c959330f52c81982cf83474404\",\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Recurring Price Preservation\",\n \"new_value\": \"1\"\n }\n}\nUpdate the next recurring price preservation by Order ID + Variant ID. This will update the target line items that match the variant_id parameter:
Request\n{\n \"order_id\": 29249,\n \"variant_id\": 6,\n \"is_preserve\": 0\n}\n\nResponse\n{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"affected_subscription_ids\": [\n \"225c0c4f0948f4ee7ba86b481580dd76\"\n ],\n \"update_type\": \"Recurring Price Preservation\",\n \"new_value\": \"0\"\n }\n}\nUpdate one or more line items associated with your subscription. Target all line items on an order, or a subset of line items based upon various criteria.
\n","_postman_id":"64b9eb57-83dc-44d8-b343-8eef23f8f075","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Bill Subscription Now","id":"0ab34fec-1499-4469-924b-d873e962cf70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/bill_now","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","bill_now"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"090da0d6-92ef-46be-ae90-a1a0333a9ef8","name":"Bill Subscription Now DECLINE","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/bill_now"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 16:48:39 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=6g7lvtm5ikn79i3rumkam3dl5c; expires=Tue, 08-Oct-2019 18:03:43 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"229"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"errorFound\": 1,\n \"declineReason\": \"Force Bill ERROR =>: This transaction has been declined\",\n \"responseCode\": 800,\n \"responseMessage\": \"Force Bill ERROR =>: This transaction has been declined\",\n \"orderId\": 10182\n }\n}"},{"id":"43d9b445-b7a3-45ae-bfc6-4901f5b8236d","name":"Bill Subscription Now APPROVED","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/bill_now"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 16:47:48 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=6g7lvtm5ikn79i3rumkam3dl5c; expires=Tue, 08-Oct-2019 18:02:52 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"290"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"errorFound\": 0,\n \"transactionID\": \"Not Available\",\n \"authId\": \"Not Available\",\n \"responseCode\": 100,\n \"responseMessage\": \"The order was billed successfully. The original order #10180 was archived and recurring was stopped. New order ID#10181 was created.\",\n \"orderId\": 10181\n }\n}"},{"id":"89008a97-1a1e-467e-9e12-551b2456886b","name":"Bill Subscription Now Invalid ID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/bill_now"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Tue, 08 Oct 2019 16:49:36 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=6g7lvtm5ikn79i3rumkam3dl5c; expires=Tue, 08-Oct-2019 18:04:40 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Subscription ID\"\n}"}],"_postman_id":"0ab34fec-1499-4469-924b-d873e962cf70"},{"name":"Update Recurring Date","id":"081000c4-9cc2-4186-883a-210d5a2e14ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"recur_at\":\"2019-10-10\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/recur_at","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","recur_at"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"05ace2d6-8142-410c-8968-bc8aeea469d8","name":"Update Recurring Date Invalid Format","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"recur_at\": \"10-20-2019\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/recur_at"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 18:49:42 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:04:42 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"165"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Request\",\n \"data\": {\n \"recur_at\": [\n \"The recur at does not match the format Y-m-d.\",\n \"The recur at must be a date after yesterday.\"\n ]\n }\n}"},{"id":"8e261c2b-3f88-4838-8af8-1e20082361ed","name":"Update Recurring Date Invalid Subscription ID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"recur_at\": \"2019-10-10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/recur_at"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 18:47:43 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:02:43 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"69"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16008,\n \"message\": \"Invalid Subscription ID\"\n}"},{"id":"a998b8d8-b7ad-4eb7-86f6-7f23333955b6","name":"Update Recurring Date Invalid Date","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"recur_at\": \"2019-10-10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/recur_at"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 18:49:06 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:04:06 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"117"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"message\": \"Invalid Request\",\n \"data\": {\n \"recur_at\": [\n \"The recur at must be a date after yesterday.\"\n ]\n }\n}"},{"id":"c0c4bb06-ac89-417a-acf0-bfc4f248c115","name":"Update Recurring Date Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"recur_at\": \"2019-10-30\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/recur_at"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 18:49:25 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:04:25 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"081000c4-9cc2-4186-883a-210d5a2e14ac"},{"name":"Update Offer","id":"5bc4dda2-694a-45ef-bc8c-927cba715eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 1,\n \"product_id\": 2\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","offer"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[{"id":"1183ef5f-9c64-45b1-b365-3249ef0129e1","name":"Update Offer Standard","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 2,\n \"product_id\": 12\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:28:21 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:43:30 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"2a5150d4-2b4b-4c05-8ca9-c774a12c87e0","name":"Update Offer and Product to a Custom Bundle","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 1,\n \"product_id\": 64,\n \"children\": [\n {\n \"product_id\": 35,\n \"quantity\": 4\n },\n {\n \"product_id\": 31,\n \"quantity\": 3\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"2b8acff7-d317-4995-883f-d01357614ff9","name":"Update Offer and Product to a Custom Bundle","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 1,\n \"product_id\": 64,\n \"children\": [\n {\n \"product_id\": 35,\n \"quantity\": 4\n },\n {\n \"product_id\": 31,\n \"quantity\": 3\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null},{"id":"3eafdb23-c0b5-4c14-b798-c3f190683d88","name":"Update Offer Seasonal","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 9,\n \"position\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:31:57 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:47:01 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"4105c47c-7944-4c7c-abfa-8f2c2fe0feb1","name":"Update Offer Product not on Offer","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 1,\n \"product_id\": 17\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:42:43 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=r7gjat7o05i6oo6c1ejunt53em; expires=Mon, 28-Oct-2019 20:57:46 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"110"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16008,\n \"message\": \"Product id supplied is not available on the subscription's offer\"\n}"},{"id":"4665df08-d58b-4f22-ab57-9561d0db91b6","name":"Update Offer Invalid Prepaid Cycles for Offer","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 10,\n \"position\": 1,\n \"prepaid_cycles\": 21\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:33:34 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:48:38 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"147"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16055,\n \"message\": \"The offer_id prepaid_cycles combination supplied is invalid. The offer does not offer that cycle term\"\n}"},{"id":"47735948-9ac6-4c88-9c4f-f48a2c2e7024","name":"Update Offer Prepaid","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 4,\n \"prepaid_cycles\": 12,\n \"product_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:31:34 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:46:39 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"863c24a2-d126-4f21-9d5b-49a5a022c1e0","name":"Update Offer Seasonal Prepaid","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 10,\n \"position\": 1,\n \"prepaid_cycles\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:33:08 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=dckjb736204om9idr4j7f3lbh4; expires=Mon, 28-Oct-2019 20:48:12 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"},{"id":"de0927dd-e32b-49e9-8e35-a328cb0148f0","name":"Update Offer Seasonal Invalid Position","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"offer_id\": 10,\n \"position\": 5,\n \"prepaid_cycles\": 4\n}","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/offer"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 28 Oct 2019 19:41:25 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Set-Cookie","value":"token=r7gjat7o05i6oo6c1ejunt53em; expires=Mon, 28-Oct-2019 20:56:28 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"code\": 16008,\n \"message\": \"The position supplied is not available on the offer_id supplied\"\n}"}],"_postman_id":"5bc4dda2-694a-45ef-bc8c-927cba715eac"},{"name":"Force Next Gateway by Order IDs","id":"185660d5-fe68-4d6e-aba1-56ffee8697e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"view\": \"order\",\n \"gateway_id\": 132,\n \"is_preserve\": 1,\n \"keys\": [\n 29500,\n 29501\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions","description":"Force the next gateway for subscriptions tied to specified order IDs. keys is an array of Order IDs.
Gets the subscription for the given ID.
\nResponse Data
Response parameters expected in object contained within the data field object:
This function allows to list subscriptions based on the filter passed in the URL.\nfilter possible values: order, email.\nIf filter is email then the parameter value in the request should be an email address, if it is order then value should be an order id.
A email address you wish to filter
\n","type":"text/plain"},"key":"value","value":"test@email.com"}],"variable":[]}},"response":[{"id":"f0524f33-10f2-47eb-9c2c-6bdb67ad7d54","name":"Get Subsciption","originalRequest":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 23 Jan 2020 14:02:06 GMT"},{"key":"Server","value":"Apache/2.4.41 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"1363"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": \"b98daa0331cf5c5857fffd2324041988\",\n \"created_at\": \"2020-01-06 14:28:26\",\n \"is_recurring\": 0,\n \"recur_at\": \"2020-01-13\",\n \"depth\": 1,\n \"forecasted_revenue\": \"99.99\",\n \"credit\": \"0.00\",\n \"product\": {\n \"id\": 22,\n \"variant_id\": 0,\n \"name\": \"Consent Product\",\n \"quantity\": 1,\n \"children\": []\n },\n \"next_product\": {\n \"id\": 22,\n \"name\": \"Consent Product\",\n \"quantity\": 1,\n \"children\": []\n },\n \"shipping\": {\n \"first_name\": \"Wade\",\n \"last_name\": \"Test\",\n \"address\": \"123 Main St\",\n \"address2\": \"\",\n \"city\": \"Tampa\",\n \"state\": \"FL\",\n \"zip\": \"33607\",\n \"country\": \"United States\",\n \"country_iso2\": \"US\"\n },\n \"discounts\": {\n \"flat_amount\": \"0.00\",\n \"percent\": 0,\n \"prepaid\": \"0.00\"\n },\n \"status\": \"cancelled\",\n \"billing_model\": {\n \"id\": 3,\n \"name\": \"Every 7 Days\",\n \"expire_cycles\": 0,\n \"buffer_days\": 0,\n \"created_at\": {\n \"date\": \"2019-04-29 15:14:41.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"updated_at\": {\n \"date\": \"2019-05-14 14:30:09.000000\",\n \"timezone_type\": 3,\n \"timezone\": \"America/New_York\"\n },\n \"is_archived\": 0,\n \"is_preserve_quantity\": 1,\n \"is_default\": null,\n \"week\": 0,\n \"day\": 0,\n \"days\": 7,\n \"date\": 7,\n \"dates\": [],\n \"description\": \"Bills every 7 days\",\n \"type\": {\n \"id\": 1,\n \"name\": \"Bill by cycle\"\n },\n \"creator\": {\n \"department_id\": 3,\n \"id\": 2,\n \"is_active\": 1,\n \"name\": \"Primary Admin\",\n \"email\": \"developers@limelightcrm.com\",\n \"call_center_provider_id\": 0\n },\n \"updator\": {\n \"department_id\": 0,\n \"id\": 1,\n \"is_active\": 1,\n \"name\": \"Lime Light CRM\",\n \"email\": \"admin@limelightcrm.com\",\n \"call_center_provider_id\": 0\n }\n }\n }\n}"}],"_postman_id":"fa749acc-07ad-421d-9811-e8459f3f7ed2"},{"name":"Get Subsciption History","id":"f427b714-fcd5-4abe-b363-7f52f628e399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}subscriptions/{{subscription_id}}/history","description":"Returns all orders in the history (order chain) of the given Subscription ID.
\nWhen a single transaction is made with more than one subscription product the first product is created as an 'Order' model and all subsequent products in that order are created as 'Upsell' models.
\nUpsells are included in this response along with their main order data in the 'main' key.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{subscription_id}}","history"],"host":["{{app_key}}","{{domain}}{{v2_ext}}subscriptions"],"query":[],"variable":[]}},"response":[],"_postman_id":"f427b714-fcd5-4abe-b363-7f52f628e399"}],"id":"bfd7e5ff-3ae2-473a-9e7e-235ad18ffeb3","description":"Below you will find methods related to Subscriptions
\n","event":[{"listen":"prerequest","script":{"id":"b4e8c282-6d3b-4aa6-af28-812ac11a5e2b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db6311c2-b85a-4566-abd2-1c7eae654e9a","type":"text/javascript","exec":[""]}}],"_postman_id":"bfd7e5ff-3ae2-473a-9e7e-235ad18ffeb3","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Calculate Order Total","id":"c77de297-f824-43c2-9ccf-b9082a00667d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\":18,\r\n \"shipping_id\":4,\r\n \"use_tax_provider\":0,\r\n \"offers\":[\r\n { \r\n \"id\":16,\r\n \"product_id\":2,\r\n \"billing_model_id\":4,\r\n \"quantity\":1,\r\n \"trial\":1\r\n }\r\n ],\r\n \"location\":{\r\n \"state\":\"FL\",\r\n \"country\":\"US\",\r\n \"postal_code\":33625\r\n },\r\n \"promo\":{\r\n \"code\":\"CODE100\",\r\n \"email\":\"newemail@test.com\"\r\n }\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}order_total/calculate","description":"Calculate the pending order total from the request.
\nRequest Data
Request parameters expected during this API call:
This API returns an array of line item calculations grouped by recurring date. To request calculations for a specific recurring date, use the \"recurring_date\" parameter.
\nTo include tax calculations and exclude shipping calculations from the response, set \"calculate_shipping\" to true and \"calculate_tax\" to false in the request payload or as needed. If calculate_shipping is true or omitted, the shipping calculations will be included, and their respective arrays will be returned. If calculate_tax is true, tax calculations will be included, and their respective arrays will be returned.
\nRequest Data
Request parameters expected during this API call:
If consent is required for an order, use this method to confirm that consent has been received
\n","urlObject":{"protocol":"https","path":["{{order_id}}","consent"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"373616f9-cd0a-4cab-b5a9-6c1ea860dcac"},{"name":"Unbundle Items","id":"aab9cf89-ce04-44c3-937d-3cbdf21b1c1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":false},"method":"POST","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/consent","description":"If consent is required for an order, use this method to confirm that consent has been received
\n","urlObject":{"protocol":"https","path":["{{order_id}}","consent"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[],"_postman_id":"aab9cf89-ce04-44c3-937d-3cbdf21b1c1a"},{"name":"GET Assigned License Keys","id":"9bece52f-0560-451d-82ff-c3e6ff4099b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/license_keys","description":"Get the License Keys for Products on an Order
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{order_id}}","license_keys"],"host":["{{app_key}}","{{domain}}{{v2_ext}}orders"],"query":[],"variable":[]}},"response":[{"id":"0d922bfc-cb9c-477c-a8b9-f86f8929f825","name":"GET Assigned License Keys","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}orders/{{order_id}}/license_keys"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Mon, 19 Oct 2020 12:52:18 GMT"},{"key":"Server","value":"Apache/2.4.43 ()"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"108"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"product_id\": 456,\n \"product_name\": \"plk product\",\n \"key\": \"licensekey50\"\n }\n ]\n}"}],"_postman_id":"9bece52f-0560-451d-82ff-c3e6ff4099b8"}],"id":"22c406cd-3dac-4a2c-b188-8738b79ea7dc","description":"Below you will find methods related to Orders
\n","_postman_id":"22c406cd-3dac-4a2c-b188-8738b79ea7dc","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Offers","item":[{"name":"Meta","item":[{"name":"Get Offer Types","id":"f4799a59-a407-4b66-aec0-d9941748637a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/types","description":"Fetch a list of all the offer types.
\nResponse Data
Response parameters expected in each response object contained within the data field array:
Fetch a list of cycle type objects.
\nResponse Data
Response parameters expected in the cycle types object contained within the data field array:
Fetch a list of all the terminating cycle types.
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
Below you will find methods to retrieve different IDs needed for creating and updating Offer(s)
\n","_postman_id":"3cf4fd7d-869e-4a17-9a60-74554962a8cd","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Configurations","item":[{"name":"Delete Configuration","id":"f8bf066f-75d7-4605-897f-b456ea7ee7a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/{{offer_id}}/configurations/{{offer_configuration_id}}","description":"Delete an existing offer configuration.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{offer_id}}","configurations","{{offer_configuration_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}offers"],"query":[],"variable":[]}},"response":[{"id":"3c04331f-a820-4d3b-b1a8-37c08a4fe82a","name":"Delete Configuration","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/{{offer_id}}/configurations/{{offer_configuration_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 09 May 2019 18:18:50 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.38 (Amazon)"},{"key":"Set-Cookie","value":"token=6u6ksungj13r6i5jbj6htlser9; expires=Thu, 09-May-2019 19:33:52 GMT; Max-Age=4500; path=/; secure"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"f8bf066f-75d7-4605-897f-b456ea7ee7a1"},{"name":"Update Configuration","id":"e6ad5ee9-be86-4385-b45a-eadadf12d8b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\":\"updated name\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/{{offer_id}}/configurations/{{offer_configuration_id}}","description":"Update an existing offer configuration.
\nRequest Data
Request parameters expected during this API call:
Create a new offer configuration.
\nRequest Data
Request parameters expected during this API call:
Fetch a specific offer configuration object by ID.
\nResponse Data
Response parameters expected in the configuration object contained within the data field object:
Returns a list of all the offer configuration objects.
\nResponse Data
Response parameters expected in the configuration object contained within the data field array:
Below you will find methods for Offer Configurations
\n","_postman_id":"31079579-f432-4a23-b792-1904a7771fc2","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Get Offer","id":"07e3936e-899a-4317-a517-9136391c43d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/{{offer_id}}","description":"Fetch a specific offer object by ID.
\nResponse Data
Response parameters expected in each response object contained within the data field object:
This method is used to get all available offers.
\nMax Requests Per Minute: 120
\nUpdate Offer details by passing Offer Id in the end point and other parameters in the body.
\nTo update or add next-cycle products, the products list must be included inside the recurring parameter.
Create a new offer
\nRequest Data
Request parameters expected during this API call:
Delete an existing offer.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{offer_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}offers"],"query":[],"variable":[]}},"response":[{"id":"fec4230d-4bdb-4fb2-b9c2-71fbfa1d7ad9","name":"Delete Offer","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}offers/22"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 17 Oct 2019 14:17:02 GMT"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Pragma","value":"no-cache"},{"key":"Server","value":"Apache/2.4.39 (Amazon)"},{"key":"Set-Cookie","value":"token=ohd43fncpbskc9a10nrhbul6bv; expires=Thu, 17-Oct-2019 15:32:05 GMT; Max-Age=4500; path=/; secure; HttpOnly"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"1d4898cf-d64c-41c6-8095-1739ae9d37f0"}],"id":"d3bbea79-6cfa-4e94-bc34-7afc3e7fde11","description":"Below you will find methods related to Offers
\n","event":[{"listen":"prerequest","script":{"id":"25decbe7-57a0-4590-8237-ecc94209c258","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e88327d-9c14-40df-af9a-6a1b01263d85","type":"text/javascript","exec":[""]}}],"_postman_id":"d3bbea79-6cfa-4e94-bc34-7afc3e7fde11","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Products","item":[{"name":"Attributes","item":[{"name":"Get Product Attributes","id":"223ed39a-929b-4cd3-9acf-1f16f453421a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/x-www-form-urlencoded"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/attributes","description":"Fetch a list of variant attributes from a product.
\nResponse Data
Response parameters contained within the data field array:
Add one or more variant attributes to a product.
\nNOTE: This method will update the attributes of the product to the set passed in the request. If you would like to keep your existent configuration of attributtes, these should be passed along in the request.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Delete one or more variant attributes from a product.
\nNOTE: If ALL is passed as a value all options and the attribute itself are going to get deleted.
Request Data
Request parameters expected during this API call:
Response Data
No data is returned. Look for a standard standard SUCCESS indicator in the status field.
Below you will find methods related to Product Attributes which is to be used in tandem with Product Variants
\n","_postman_id":"d281b0f2-5da7-458b-87b7-28bedf0c5334","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Categories","item":[{"name":"Add Category","id":"87acfc83-e38f-4eca-aa49-c191e952b44c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Category Name\",\r\n \"description\":\"This is where the description goes\"\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}categories","description":"Add a product category.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Update an existing product category.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Fetch a list of product categories.
\nResponse Data
Response parameters contained within the data field array:
Delete a product category.
\nNote A category can not be deleted if products are attached.
\nResponse Data
No data is returned. Look for a standard standard SUCCESS indicator in the status field.
Fetch a list of product categories.
\nResponse Data
Response parameters contained within the data field array:
Product Categories. The API Permissions used for these routes are the same as the Product permissions
\n","event":[{"listen":"prerequest","script":{"id":"2af2e385-ff72-478d-89b2-91979f306bf7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"40c7fafd-336d-4039-a23a-81d08ceca666","type":"text/javascript","exec":[""]}}],"_postman_id":"1067a2d5-369c-487a-a05b-39b9cb3aa701","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Images","item":[{"name":"Get Product Image","id":"37e2697d-6d27-47ac-9e13-29867a3c3a9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/images/{{image_id}}","description":"Fetch a single image associated with a product.
\nResponse Data
Response parameters contained within the data field object:
Fetch a list of images associated with a product.
\nResponse Data
Response parameters contained within the data field array:
Detach a single image from a product.
\nResponse Data
No data is returned. Look for a standard standard SUCCESS indicator in the status field.
Attach images to product only if none present.
\nNOTE: If images already exist on this product, you must use the Attach Product Images method.
Request Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Append image relationships to product, maintaining existing relationships.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Detach existing images from a product and attach requested images.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Fetch a list of product bundle types.
\nResponse Data
Response parameters contained within the data field array:
Fetch a list of product bundle price types.
\nResponse Data
Response parameters contained within the data field array:
Fetch a list of product weight types.
\nResponse Data
Response parameters contained within the data field array:
Append image relationships to product variant, maintaining existing relationships.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Fetch a list of images associated with a product variant.
\nResponse Data
Response parameters contained within the data field array:
Fetch a single image associated with a product variant.
\nResponse Data
Response parameters contained within the data field object:
Detach a single image from a product variant.
\nResponse Data
No data is returned. Look for a standard standard SUCCESS indicator in the status field.
Attach images to product variant only if none present.
\nNOTE: If images already exist on this product variant, you must use the Attach Variant Images method.
Request Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Detach existing images from a product variant and attach requested images.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field array:
Fetch a list of product variants associated with a single product.
\nResponse Data
Response parameters contained within the data field array:
Update an existing product variant.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Add a new product variant.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Delete a product variant.
\nResponse Data
Response parameters contained within the data field object:
Below you will find methods related to Product Variants which is to be used in tandem with Product Attributes
\n","_postman_id":"5815adc4-90b1-4df8-b980-667c084b6841","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Add Product","id":"85a88742-6b57-470a-b356-e34d3641352e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Adding Example Product\",\n \"sku\": \"ABC1234343433\",\n \"category_id\": 1,\n \"description\": \"Describe me in just a few words please.\",\n \"price\": 999.99,\n \"max_quantity\": 10,\n \"auto_create_variants\": 1,\n \"attributes\": [\n {\n \"name\": \"Brand\",\n \"options\": [\n \"NIKE\",\n \"ReeBok\",\n \"PuMa\"\n ]\n },\n {\n \"name\": \"Color\",\n \"options\": [\n \"ReD\",\n \"GrEeN\",\n \"bLuE\"\n ]\n }\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products","description":"Create a new standard, bundle, or variant product.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Fetch a list of products.
\nResponse Data
Response parameters contained within the data field array:
Fetch a single product object.
\nResponse Data
Response parameters contained within the data field object:
Update an existing product.
\nRequest Data
Request parameters expected during this API call:
Response Data
Response parameters contained within the data field object:
Delete a product.
\nResponse Data
No data is returned. Look for a standard standard SUCCESS indicator in the status field.
Fetch a list of all custom fields created for products
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
Attach an existing product's custom fields and assign values for them to the product.
\nRequest Data
Request parameters expected during this API call:
Note: Any Custom Field Values that are NOT included in the Update payload WILL be DELETED
\nUpdate custom fields list that attached to the product .
\nRequest Data
Request parameters expected during this API call:
Delete an existing custom field from the list attached to the product
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{product_id}}","custom_fields","{{custom_field_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}products"],"query":[],"variable":[]}},"response":[{"id":"e9bc68bc-4fd9-40b9-8a38-3fe5602cb99d","name":"Delete Custom Field Values","originalRequest":{"method":"DELETE","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/custom_fields/{{custom_field_id}}"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"3dc9111c-bd03-49cf-888e-aab2d79cdf5d"},{"name":"Get Assigned Product License Keys","id":"8949d690-b18f-42f7-bca4-003e33accaed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/licenses/assigned","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{product_id}}","licenses","assigned"],"host":["{{app_key}}","{{domain}}{{v2_ext}}products"],"query":[{"disabled":true,"key":"assigned","value":"2"},{"disabled":true,"description":{"content":"Required when assigned value is 1. Start date of windows for assigned license keys. Expected date format: YYY-MM-DD
\n","type":"text/plain"},"key":"search[status_id]","value":"::0"},{"disabled":true,"description":{"content":"Required when assigned value is 1. End date of windows for assigned license keys. Expected date format: YYY-MM-DD
\n","type":"text/plain"},"key":"search[][]","value":"'2019-02-10'"}],"variable":[]}},"response":[{"id":"13f3e5a2-7221-4d49-92ce-13a1977a4ebb","name":"Get Assigned Product License Keys","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/licenses/assigned?start_at=2019-01-01&end_at=2019-02-10","protocol":"https","host":["{{app_key}}","{{domain}}{{v2_ext}}products"],"path":["{{product_id}}","licenses","assigned"],"query":[{"key":"start_at","value":"2019-01-01","description":"Optional| If not passed in that case, system will get the product licenses feature's creation date as the start date."},{"key":"end_at","value":"2019-02-10","description":"Optional| If not passed in that case, system will get today's date as the end date."}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"key\": \"123456klolp\",\n \"product_id\": 78,\n \"status_id\": 2,\n \"held_at\": \"2019-02-04 12:37:32\",\n \"created_at\": \"2019-02-04 12:27:11\",\n \"status_name\": \"Assigned\"\n }\n ],\n \"first_page_url\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 4,\n \"total\": 4\n}"}],"_postman_id":"8949d690-b18f-42f7-bca4-003e33accaed"},{"name":"Get Unassigned Product License Keys","id":"c22b4e77-5c57-4bab-97f3-45a02b2ee8ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/licenses/unassigned","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{product_id}}","licenses","unassigned"],"host":["{{app_key}}","{{domain}}{{v2_ext}}products"],"query":[],"variable":[]}},"response":[{"id":"369c4a4f-5f7b-4428-80fb-ce84f8ebb45c","name":"Get Unassigned Product License Keys","originalRequest":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}products/{{product_id}}/licenses/unassigned"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 2,\n \"key\": \"1234asdf\",\n \"product_id\": 78,\n \"status_id\": 0,\n \"order_id\": null,\n \"held_at\": null,\n \"created_at\": \"2019-02-04 12:36:51\",\n \"status_name\": \"New\"\n },\n {\n \"id\": 3,\n \"key\": \"asdaf123213\",\n \"product_id\": 78,\n \"status_id\": 0,\n \"order_id\": null,\n \"held_at\": null,\n \"created_at\": \"2019-02-04 12:37:01\",\n \"status_name\": \"New\"\n },\n {\n \"id\": 4,\n \"key\": \"1235645asdasdasd\",\n \"product_id\": 78,\n \"status_id\": 0,\n \"order_id\": null,\n \"held_at\": null,\n \"created_at\": \"2019-02-04 12:37:09\",\n \"status_name\": \"New\"\n }\n ],\n \"first_page_url\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses/unassigned?page=1\",\n \"from\": 1,\n \"last_page\": 1,\n \"last_page_url\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses/unassigned?page=1\",\n \"next_page_url\": null,\n \"path\": \"http://ricardo.dev2.limelightcrm.com/cloud/api/v2/products/78/licenses/unassigned\",\n \"per_page\": 15,\n \"prev_page_url\": null,\n \"to\": 3,\n \"total\": 3\n}"}],"_postman_id":"c22b4e77-5c57-4bab-97f3-45a02b2ee8ee"}],"id":"0f84a44e-100d-48b6-b795-6176452f30a5","description":"Manage your platform products, bundles, attributes, variants, licenses, images, and product custom fields using the Product API.
\n","_postman_id":"0f84a44e-100d-48b6-b795-6176452f30a5","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Prospects","item":[{"name":"Get Prospect Custom Fields","id":"5c01454b-5cb4-47e7-a383-3d892373e06e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}custom_fields/prospects","description":"Fetch a list of all custom fields created for prospects
\nResponse Data
Response parameters expected in custom field object contained within the data field array:
Attach an existing prospect's custom fields and assign values for them to the prospects.
\nRequest Data
Request parameters expected during this API call:
Update custom fields list that attached to the prospect.
\nRequest Data
Request parameters expected during this API call:
Delete an existing custom field from the list attached to the customer
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{prospect_id}}","custom_fields","{{custom_field_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}prospects"],"query":[],"variable":[]}},"response":[{"id":"a5237be6-267b-41c4-87cd-6bceb028a7ed","name":"Delete Custom Field Values","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}prospects/{{prospect_id}}/custom_fields/{{custom_field_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Wed, 07 Nov 2018 12:31:07 GMT"},{"key":"Server","value":"Apache/2.4.34 (Amazon)"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"633d4ce5-2622-43c4-87d2-215714d57ec2"},{"name":"Get Prospect Interests","id":"bfc02c1b-a130-4305-b4da-835a85ea58a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}prospects/{{prospect_id}}/interests","description":"Fetch a list of all interests created for prospects
\nResponse Data
Response parameters expected in interest object contained within the data field array:
Create an interest entity for the prospect.
\nRequest Data
Request parameters expected during this API call:
Fetch a list of shipping type objects.
\nResponse Data
Response parameters expected in each shipping type object contained within the data field array:
Fetch a specific shipping type object by ID.
\nResponse Data
Response parameters expected in the shipping type object contained within the data field object:
Retrieve a list of shipping price types. These types specify how an order will determine its shipping price.
\nType IDs
\nResponse Data
\nResponse parameters expected in each shipping price type object contained within the data field array:
Create a shipping type.
\nRequest Data
Request parameters expected during this API call:
Update an existing shipping type.
\nRequest Data
Request parameters expected during this API call:
Delete an existing shipping type.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{shipping_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}shipping"],"query":[],"variable":[]}},"response":[{"id":"fc360fc0-425f-4c3b-904c-5c4c30543a00","name":"Delete Shipping Type","originalRequest":{"method":"DELETE","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}shipping/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 03 Mar 2022 14:57:32 GMT"},{"key":"Server","value":"Apache/2.4.51 ()"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"9a4b3450-ab6a-44a4-9c34-5e5243f682c7"}],"id":"593e8d9f-750b-4599-944c-7b16e0a85b3e","_postman_id":"593e8d9f-750b-4599-944c-7b16e0a85b3e","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Get Shipping Methods","id":"240bc49b-19ac-4286-98ea-9485c70677e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}shipping","description":"Fetch a list of shipping method objects.
\nResponse Data
Response parameters expected in each shipping method object contained within the data field array:
Fetch a specific shipping method object by ID.
\nResponse Data
Response parameters expected in the shipping method object contained within the data field object:
Fetch a specific shipping method object by ID.
\nRequest Data
Request parameters expected during this API call:
Fetch a specific shipping method object by ID.
\nRequest Data
Request parameters expected during this API call:
Delete an existing shipping method.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{shipping_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}shipping"],"query":[],"variable":[]}},"response":[{"id":"f570d460-98a8-4815-8c6f-907c5bc75495","name":"Delete Shipping Method","originalRequest":{"method":"DELETE","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}shipping/17"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Date","value":"Thu, 03 Mar 2022 18:32:19 GMT"},{"key":"Server","value":"Apache/2.4.51 ()"},{"key":"Vary","value":"Authorization"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"29c9a6f5-edfc-481e-b7f7-00480800b6d1"}],"id":"54f98e84-f4c2-4516-9fd9-f06e4a7b3f45","_postman_id":"54f98e84-f4c2-4516-9fd9-f06e4a7b3f45","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Tokenization","item":[{"name":"Tokenize Payment","id":"571e25ab-ae74-4868-a45a-36e1c4719556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"card_number\" : \"1312332123424212\",\n\t\"cvv\" : \"123\",\n\t\"expiry\" : \"10-2020\",\n\t\"brand\" : \"visa\"\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}tokenize_payment","description":"Get a temporary token that will be used as an alternative to sending personal cardholder information (card number, expiry, CVV) with a new_order call. It is passed to new_order via the payment_token attribute. The token is valid for 15 minutes
Request Data
Request parameters expected during this API call:
This call is intended to be used to tokenize API credentials for each API endpoint.\nThe token in the response from this call can be used as the replacement of your plain API credentials (username and password), this is an alternative to keep your API credentials secure when making API calls.
\n##How to use the token\nThe token should be pass as a Bearer token in the Authorization header for the API call passed when creating the token. For example:
A call to /api/v2/token/tokenize_payment will create a token specifically for the tokenize_payment endpoint, that token should be passed as a Bearer token in the Authorization header for the subsequent call to /api/v2/tokenize_payment.
##Important Note\nThe life of the token is 10 minutes from the time of its creation.
\n","auth":{"type":"basic","basic":{"password":"Fetch a list of user objects.
\nResponse Data
Response parameters expected in each user objects contained within the data field array:
Fetch a list of call center provider objects.
\nResponse Data
Response parameters expected in each call center provider objects contained within the data field array:
Fetch a list of department objects.
\nResponse Data
Response parameters expected in each department objects contained within the data field array:
Create one or multiple representment cases.
\nRequest Data
Request parameters expected during this API call:
Fetch a list of trial workflow objects.
\nResponse Data
Response parameters expected in each trial workflow object contained within the data field array:
Fetch a specific trial workflow object by ID.
\nResponse Data
Response parameters expected in the trial workflow object contained within the data field object:
Create a trial workflow.
\nRequest Data
Request parameters expected during this API call:
Copy a trial workflow.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1","copy"],"host":["{{app_key}}","{{domain}}{{v2_ext}}trial-workflows"],"query":[],"variable":[]}},"response":[],"_postman_id":"81feec06-3411-40cc-a70f-064976028d4c"},{"name":"Update Trial Workflow","id":"5b9956f3-b308-40e1-8a69-9240106a0820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Advanced Trial Workflow\",\n \"is_active\":1,\n \"replace\":1,\n \"units\":[\n {\n \"step_number\":1,\n \"name\":\"Reservation Charge\",\n \"duration\":2,\n \"price\":2.75,\n \"is_parent_cancellable\":0,\n \"product_id\":4,\n \"is_shippable\":0,\n \"is_notifiable\":0,\n \"is_one_time_pairable\":0,\n \"shipping_price_type_id\": 4,\n \"shipping_price\": 4.95\n },\n {\n \"step_number\":2,\n \"name\":\"Service Charge\",\n \"duration\":18,\n \"price\":10.00,\n \"is_parent_cancellable\":1,\n \"is_shippable\":0,\n \"is_notifiable\":0,\n \"is_one_time_pairable\":0,\n \"shipping_price_type_id\": 2\n },\n {\n \"step_number\":3,\n \"name\":\"Confirmation Charge\",\n \"duration\":10,\n \"price\":20.00,\n \"is_parent_cancellable\":1,\n \"is_shippable\":1,\n \"is_notifiable\":1,\n \"is_one_time_pairable\":1\n }\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}trial-workflows/4","description":"Update an existing trial workflow.
\nRequest Data
Request parameters expected during this API call:
Delete an existing trial workflow.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1"],"host":["{{app_key}}","{{domain}}{{v2_ext}}trial-workflows"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ca5a7f4-9570-4cb8-919f-7cc5a710229f"},{"name":"Relate To Offer","id":"4b0fb0e9-7901-4dd5-90d5-54a0086d01eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"is_default\":1}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}trial-workflows/1/offer/196","description":"Associate a trial workflow to an offer.
\nRequest Data
\nA request body is not required for this API call. However, you can send the following request parameter(s):
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1","offer","196"],"host":["{{app_key}}","{{domain}}{{v2_ext}}trial-workflows"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b0fb0e9-7901-4dd5-90d5-54a0086d01eb"},{"name":"Relate Many To Offer","id":"2f75db2a-0826-4c42-a3fb-4cc4a8288e65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n {\n \"id\": 1,\n \"is_default\": 0\n },\n {\n \"id\": 2,\n \"is_default\": 1\n }\n ]\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}trial-workflow-offer/184/relate","description":"Associate 1 or more trial workflows to a single offer.
\nRequest Data
\nRequest parameters expected during this API call:
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["184","relate"],"host":["{{app_key}}","{{domain}}{{v2_ext}}trial-workflow-offer"],"query":[],"variable":[]}},"response":[],"_postman_id":"2f75db2a-0826-4c42-a3fb-4cc4a8288e65"},{"name":"Unrelate From Offer","id":"a2e506d8-7e77-44c6-8fe2-099f8aa9858c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}trial-workflows/1/offer/196","description":"Break the association between a trial workflow and an existing offer.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["1","offer","196"],"host":["{{app_key}}","{{domain}}{{v2_ext}}trial-workflows"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2e506d8-7e77-44c6-8fe2-099f8aa9858c"}],"id":"94c82590-e932-4233-af0c-f7fa55f297f4","description":"Orchestrate a sequence of billing events with trial workflows.
\n","_postman_id":"94c82590-e932-4233-af0c-f7fa55f297f4","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Inventories","item":[{"name":"Get All Inventories","id":"0dc66b40-2586-4b97-ad0c-d12482de85f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}inventories","description":"This method is used to get all Inventories.
\nResponse parameters contained within the data field object:
Get all inventories for a single product by passing product id in URL.
\nResponse parameters contained within the data field object:
Update an existing product inventory.
\nRequest Data
Request parameters expected during this API call:
Response Data
\nResponse parameters contained within the data field object:
Update an existing product inventory.
\nRequest Data
Request parameters expected during this API call:
Response Data
\nResponse parameters contained within the data field object:
Response parameters contained within the data field object:
Manage your platform inventory of the products using the inventory API.
Below you will find methods related to inventory.
This method is used to get all warehouse.
\nResponse parameters contained within the data field object:
This method is used to get a single warehouse details.
\nResponse parameters contained within the data field object:
This method is used to update a single warehouse details.
\nRequest parameters expected during this API call:
\nResponse parameters contained within the data field object:
Delete an existing warehouse.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{warehouse_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}warehouse"],"query":[],"variable":[]}},"response":[],"_postman_id":"ccf531f2-66e9-43b8-95fc-3ae2ec288f52"},{"name":"Create Warehouse","id":"ffb1b2fd-3893-47d3-b0fb-faab35a7e9b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Test Warehouse Name-New","description":"The warehouse name.
\n","type":"text","contentType":""},{"key":"description","value":"Test description new","description":"The warehouse description.
\n","type":"text"},{"key":"address_1","value":"1234 main new str","description":"The warehouse address 1.
\n","type":"text"},{"key":"address_2","value":"new suite3","description":"The warehouse address 2.
\n","type":"text"},{"key":"city","value":"NOrlando","description":"The warehouse city.
\n","type":"text"},{"key":"state","value":"FLU","description":"The warehouse located state code.
\n","type":"text"},{"key":"zip","value":"32821","description":"The warehouse zip code.
\n","type":"text"},{"key":"country_id","value":"223","description":"The warehouse country id.
\n","type":"text"},{"key":"active","value":"1","description":"The warehouse status. It should be Boolean value 0 or 1.
\n","type":"text"}]},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}warehouse","description":"This method is used to update a single warehouse details.
\nRequest parameters expected during this API call:
\nResponse parameters contained within the data field object:
Manage your platform warehouse using the warehouse API.
Below you will find methods related to warehouse.
Currently v3 is designed for collection offer type subscriptions only and will not be working for any other subscription types
\n","_postman_id":"7f83eae8-381d-4d2b-9516-3af525700625","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Payment Router","item":[{"name":"Payment Router Gateways","id":"4f3f3992-c91f-42f0-bfe2-96345e1804b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{app_key}}.{{domain}}{{v2_ext}}payment_router/{{payment_router_id}}/gateways","description":"Fetch payment router's associated gateways.
\nResponse parameters expected in object contained within the data field:
The payload for gateway from the previous table above is returned as a JSON object. The details of gateway is formatted like in the table below.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{payment_router_id}}","gateways"],"host":["{{app_key}}","{{domain}}{{v2_ext}}payment_router"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f3f3992-c91f-42f0-bfe2-96345e1804b2"}],"id":"af98ca4b-c4f8-4d9e-89f0-809358f57592","_postman_id":"af98ca4b-c4f8-4d9e-89f0-809358f57592","description":"","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}}},{"name":"Volume Discounts","item":[{"name":"Get Volume Discounts","id":"94f03d75-9484-41ff-959f-da369f4073df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts","description":"Fetch a list of volume discount objects.
\nResponse Data
Response parameters expected in each volume discount object contained within the data field array:
Fetch a single volume discount object.
\n**Response Data
**Response parameters contained within the data field object:
Create a new volume discount.
\nRequest Data
Request parameters expected during this API call:
Response Data :
\nResponse parameters contained within the data field object:
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","host":["{{app_key}}","{{domain}}{{v2_ext}}volume-discounts"],"query":[],"variable":[]}},"response":[{"id":"2176a5c0-4770-4f20-ba8c-3c73bfa49d83","name":"Add Volume Discount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test 3\",\r\n \"description\": \"This is optional description\",\r\n \"quantities\": [\r\n {\r\n \"tier_id\": 1,\r\n \"lower_bound\": 1,\r\n \"upper_bound\": 5,\r\n \"discount_type_id\": 1,\r\n \"amount\": 5\r\n },\r\n {\r\n \"tier_id\": 2,\r\n \"lower_bound\": 6,\r\n \"upper_bound\": 10,\r\n \"discount_type_id\": 1,\r\n \"amount\": 10\r\n }\r\n ],\r\n \"products\": [\r\n 1,\r\n 2\r\n ],\r\n \"is_exclude_non_recurring\": true,\r\n \"apply_to_type_id\": 3\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Apr 2024 05:08:34 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": 111,\n \"name\": \"Test 3\",\n \"description\": \"This is optional description\",\n \"is_active\": 1,\n \"created_at\": \"2024-04-01T05:08:34.000000Z\",\n \"updated_at\": \"2024-04-01T05:08:34.000000Z\",\n \"created_by\": 1000035,\n \"updated_by\": null,\n \"is_exclude_non_recurring\": 1,\n \"apply_to_type_id\": 3,\n \"quantities\": [\n {\n \"id\": 768,\n \"volume_discount_id\": 111,\n \"lower_bound\": 1,\n \"upper_bound\": 5,\n \"discount_type_id\": 1,\n \"amount\": \"5.00\",\n \"created_at\": \"2024-04-01T05:08:34.000000Z\",\n \"updated_at\": \"2024-04-01T05:08:34.000000Z\"\n },\n {\n \"id\": 769,\n \"volume_discount_id\": 111,\n \"lower_bound\": 6,\n \"upper_bound\": 10,\n \"discount_type_id\": 1,\n \"amount\": \"10.00\",\n \"created_at\": \"2024-04-01T05:08:34.000000Z\",\n \"updated_at\": \"2024-04-01T05:08:34.000000Z\"\n }\n ],\n \"products\": [\n 1,\n 2\n ],\n \"campaigns\": []\n }\n}"}],"_postman_id":"6ba6348c-a62b-4670-8951-45592905129e"},{"name":"Copy Volume Discount","id":"da488169-8a63-489c-9f6d-210a34aea3da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts/{{volume_discount_id}}/copy","description":"Copy an existing volume discount.
\nResponse Data :
\nResponse parameters contained within the data field object:
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{volume_discount_id}}","copy"],"host":["{{app_key}}","{{domain}}{{v2_ext}}volume-discounts"],"query":[],"variable":[]}},"response":[{"id":"e050725d-74d3-40d4-8893-b3f6e25609e7","name":"Copy Volume Discount","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts/{{volume_discount_id}}/copy"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Apr 2024 08:10:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"id\": 112,\n \"name\": \"Tristin Volume Discount1 (Copy)\",\n \"description\": \"Tristin Discount Description\",\n \"is_active\": 1,\n \"created_at\": \"2024-04-01T08:10:50.000000Z\",\n \"updated_at\": \"2024-04-01T08:10:50.000000Z\",\n \"created_by\": 1000035,\n \"updated_by\": null,\n \"is_exclude_non_recurring\": 1,\n \"apply_to_type_id\": 3,\n \"quantities\": [\n {\n \"id\": 770,\n \"volume_discount_id\": 112,\n \"lower_bound\": 2,\n \"upper_bound\": 5,\n \"discount_type_id\": 1,\n \"amount\": \"5.00\",\n \"created_at\": \"2024-04-01T08:10:50.000000Z\",\n \"updated_at\": \"2024-04-01T08:10:50.000000Z\"\n },\n {\n \"id\": 771,\n \"volume_discount_id\": 112,\n \"lower_bound\": 6,\n \"upper_bound\": 10,\n \"discount_type_id\": 1,\n \"amount\": \"15.00\",\n \"created_at\": \"2024-04-01T08:10:50.000000Z\",\n \"updated_at\": \"2024-04-01T08:10:50.000000Z\"\n },\n {\n \"id\": 772,\n \"volume_discount_id\": 112,\n \"lower_bound\": 11,\n \"upper_bound\": 15,\n \"discount_type_id\": 1,\n \"amount\": \"25.00\",\n \"created_at\": \"2024-04-01T08:10:50.000000Z\",\n \"updated_at\": \"2024-04-01T08:10:50.000000Z\"\n }\n ],\n \"products\": [],\n \"campaigns\": []\n }\n}"}],"_postman_id":"da488169-8a63-489c-9f6d-210a34aea3da"},{"name":"Relate the Campaign in Volume Discount","id":"35c80189-e5e0-41d4-8114-e21cfde27964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"is_replace\": 1,\r\n \"is_all_campaigns\":false,\r\n \"campaigns\": [\r\n {\r\n \"id\": 70,\r\n \"name\": \"test postman order view campaign\"\r\n },\r\n {\r\n \"id\": 110,\r\n \"name\": \"Test prospect configuration\"\r\n },\r\n {\r\n \"id\": 2417,\r\n \"name\": \"Swapna Avalara V2\"\r\n }\r\n ]\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts/{{volume_discount_id}}/campaigns","description":"Attache campaign in volume discount.
\nRequest Data
Request parameters expected during this API call:
Attache campaign in volume discount.
\nRequest Data
Request parameters expected during this API call:
Update an existing volume discount.
\nRequest Data
Request parameters expected during this API call:
Delete an existing volume discount.
\n","auth":{"type":"basic","basic":{"password":"{{api_password}}","username":"{{api_username}}"},"isInherited":true,"source":{"_postman_id":"ef86aea7-73d2-4a65-b467-28938bb07563","id":"ef86aea7-73d2-4a65-b467-28938bb07563","name":"sticky.io Restful API v2025.7.31","type":"collection"}},"urlObject":{"protocol":"https","path":["{{volume_discount_id}}"],"host":["{{app_key}}","{{domain}}{{v2_ext}}volume-discounts"],"query":[],"variable":[]}},"response":[{"id":"b4e1c688-aed5-4f6c-b3c5-74faa118b102","name":"Delete Volume Discount","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Test 3 -update\",\r\n \"description\": \"This is optional description\",\r\n \"quantities\": [\r\n {\r\n \"id\": 545,\r\n \"lower_bound\": 1,\r\n \"upper_bound\": 5,\r\n \"discount_type_id\": 1,\r\n \"amount\": 6\r\n },\r\n {\r\n \"id\": 546,\r\n \"lower_bound\": 6,\r\n \"upper_bound\": 10,\r\n \"discount_type_id\": 1,\r\n \"amount\": 11\r\n }\r\n ],\r\n \"products\": [\r\n 1,\r\n 2\r\n ],\r\n \"is_exclude_non_recurring\": true,\r\n \"apply_to_type_id\": 3\r\n}"},"url":"https://{{app_key}}.{{domain}}{{v2_ext}}volume-discounts/{{volume_discount_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 01 Apr 2024 08:03:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains;"},{"key":"Vary","value":"Authorization"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, OPTIONS, PUT, DELETE, PATCH"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Max-Age","value":"86400"},{"key":"Access-Control-Allow-Headers","value":"Content-Type, Authorization, X-Requested-With, Platform-Key, X-CSRF-TOKEN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\"\n}"}],"_postman_id":"8fa5c9f9-c244-4410-b2b9-90a81226b968"}],"id":"a381271c-5ded-4f71-b847-98d0adcbc62b","description":"Manage your platform volume discounts using the volume discount API.
Below you will find methods related to volume discounts.