The AppBind reseller API is a REST-like API that returns JSON responses, and uses standard HTTP response codes, authentication, and verbs.
\nThis is a set of APIs for a reseller for to manage customers and subscriptions in AppBind.
\nAppBind's reseller API is currently in a limited beta release. If you would like to participate in the beta, please contact AppBind support at support@appbind.com.
\nThe AppBind reseller API uses API keys to authenticate requests. When you're added to the beta program, you'll be abled to view and manage your API secret keys in the integrations tab on the AppBind settings page:
\nClick on \"Manage custom integrations\" to navigate to a page where you can generate and manage api keys, and view an api call log history.
\nRoll key generates a new key value for an existing key name (and deactivates the current key value).
\nDeactivate key prevents a key from being used in future calls.
\nGenerate new key creates a new key name and value.
\nAPI secret keys provide access to your production environment, so be sure to keep them secure. Do not share API secret keys in publically accessible platforms such as GitHub, client-side code, etc.
\nAuthentication to the API is via bearer auth (e.g. -H \"Authorization: Bearer sk...\".
\nAll API requests must be made over https. Calls made over plain http or without authentication will fail.
\nList lookups that may return a large number of objects generally support paging. These APIs share a common format, including first, offset, sort, and direction parameters.
\n* first specifies the maximum number of objects to return; this is the page size.
* offset indicates what page to return.
* sort indicates which attribute(s) to sort by (where applicable).
* direction (ASC or DESC) indicates the sort direction.
For example, the following call to the apps resource retrieves the first 5 apps in AppBind's master catalog, ordered by app name ascending:
\nhttps://ws.appbind.com/v1/reseller/apps?first=5&offset=0&sort=appName&direction=ASC
This call retrieves the next 5 apps (note that the offset has been incremented):
\nhttps://ws.appbind.com/v1/reseller/apps?first=5&offset=1&sort=appName&direction=ASC
List lookups often support wildcard lookups on one or more attribute. For attributes that support wildcard lookup, use like:pattern. For example, to lookup apps containing the string \"AWS\" in the app name, you'd do this:
\nhttps://ws.appbind.com/v1/resellerapps?appName=like:AWS&first=10&offset=0&sort=appName&direction=ASC
Returns apps using filtering and sorting
\n","auth":{"type":"bearer","bearer":{"token":"Either a unique app name such as AWS or a wildcard prefaced with the keyword like:word
\n","type":"text/plain"},"key":"appName","value":"like:pass"},{"description":{"content":"Max number of records to return
\n","type":"text/plain"},"key":"first","value":"10"},{"description":{"content":"Number of rows to offset. For example, 0 means start with the first matching row, and 10 means start with the 11th matching row.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Field to sort by. Currently only appName
\n","type":"text/plain"},"key":"sort","value":"appName"},{"description":{"content":"ASC for ascending and DESC for descending
\n","type":"text/plain"},"key":"direction","value":"DESC"}],"variable":[]}},"response":[{"id":"69843174-8352-4195-98d8-6a6c87e7e5ee","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerRetrieve a single app entry.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique appId assigned by AppBind when the app is created.
\n","type":"text/plain"},"type":"any","value":"","key":"appId"}]}},"response":[{"id":"9523b1ff-40d0-41f5-a9d9-3fd516c20dd8","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe apps resource represents apps in the AppBind default catalog. Over time, the AppBind team adds apps to the AppBind system. These are the apps that are available to select by default when creating subscriptions in the AppBind UI. When you add a subscription to an app for the first time, a copy of that app entry (with settings that you specify as defaults) is added to your own catalog. Subsequently, you can choose the app from your catalog entry.
\nIn the API, when you create a subscription order to setup subscriptions for a customer, you'll need to know the id of each subscription in your catalog that you're adding. To get the subscription id from your catalog, you'd use the catalogapps resource. However, if you're adding an app that isn't in your catalog yet, you can look up other apps that are in the master AppBind catalog; that's what this resource is for.
\nKey attributes on this resource are:
\nappId: A unique identifier assigned by AppBind when the app is created.
\nappStatus: 0 (the default) means the app is active. 1 means inactive.
\nappName: Name of the app as seen on subscriptions.
\nsubscriptionPlan: Subscription plan / sku for the app. This may be used if the app has multiple app subscription plans (e.g. \"Starter\", \"Pro\", \"Enterprise\").
\nappUrl: Website for the application. This will typically be the login page for the app.
\nsignupUrl: Website for the application signup.
\nappLogo: Logo for the application. In the UI, this is usually displayed anywhere the subscription is present.
\nappMarkupPercentage: Markups are usually not set on AppBind master catalog apps. See the catalogapp resource for a discussion of app markups and discounts.
\nwholesaleDiscountPercentage: Wholesale discount. These are usually not set on AppBind master catalog apps. See the catalogapp resource for more information about wholesale discounts.
\npaymentOrder: In most scenarios, you'll be billing subscriptions to your customer through AppBind. However, in some scenarios, you'll be expensing subscriptions to yourself (and presumably billing your customer separately). The paymentOrder attribute indicates who will be paying for a subscription. AppBind master catalog apps are usually set to 0 (customer pay); see the catalogapp resource for more information about payment order.
\n","_postman_id":"f90019b0-e8f1-4ccf-9e81-5c9930f5ceae","auth":{"type":"bearer","bearer":{"token":"Get a catalog app.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique catalogAppId assigned by AppBind when the app is created.
\n","type":"text/plain"},"type":"any","value":"","key":"catalogAppId"}]}},"response":[{"id":"280e0d21-ef05-42f4-8d57-35e8176111ed","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a catalog app. Only specify those attributes you wish to change.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique catalogAppId assigned by AppBind when the app is created.
\n","type":"text/plain"},"type":"any","value":"","key":"catalogAppId"}]}},"response":[{"id":"6ffdae4f-15f4-4915-a51e-f0e4df5009ec","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get and update a catalog app by id.
\n","_postman_id":"e2025e64-af7f-4d27-9cf3-fc9e1e37e74d","auth":{"type":"bearer","bearer":{"token":"Get apps in your catalog using filtering and sorting
\n","auth":{"type":"bearer","bearer":{"token":"Either a unique app name such as AWS or a wildcard prefaced with the keyword like:word
\n","type":"text/plain"},"key":"appName","value":"like:Pass"},{"description":{"content":"Max number of records to return
\n","type":"text/plain"},"key":"first","value":"10"},{"description":{"content":"Number of rows to offset. For example, 0 means start with the first matching row, and 10 means start with the 11th matching row.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Field to sort by. Currently only appName
\n","type":"text/plain"},"key":"sort","value":"appName"},{"description":{"content":"ASC for ascending and DESC for descending
\n","type":"text/plain"},"key":"direction","value":"DESC"}],"variable":[]}},"response":[{"id":"15f0ca0c-ddca-4382-895a-08937e61631f","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreate a new app in your app catalog. This can either be a template version of an app from AppBind's default catalog, or a new custom app. If this is a template version of an existing app, you'll specify the appId, and set any additional attributes (e.g. markup) that govern how you create subscriptions for your customers. If this is a custom app, this means that you're adding an app to your catalog that doesn't exist in AppBind's default catalog. In this case, you're creating an app from scratch, and need to provide all required fields.
\n","auth":{"type":"bearer","bearer":{"token":"The catalogapps resource represents apps in your catalog. When you (a reseller) create a subscription in the AppBind UI, a catalog app is created. If you chose an app from AppBind's default catalog, you'll have a copy of that app in your catalog. This copy also stores choices you made (e.g. markup %) as defaults for future purchases. If you created a \"custom\" app (an app that isn't in AppBind's default catalog), that app exists just in your catalog (along with your default choices).
\nYou can use the AppBind API to create and manage your catalog apps.
\nA catalog app is created the first time an app is purchased. It can also be created manually. The purpose of the catalog is so that common settings can be established and defaulted for subsequent purchases.
\nKey related concepts:
\ncatalogAppId: A unique identifier assigned by AppBind when the app is created.
\nappStatus: 0 (default) means the app is active. 1 means inactive.
\nappName: Name of the app as seen on subscriptions.
\nsubscriptionPlan: Subscription plan of the app.
\nappUrl: Website for the application.
\nsignupUrl: Website for the application signup. appLogo: Logo for the application. Displayed anywhere the subscription is present.
\nappMarkupPercentage: Percent markup. Charges incurred with increased (positive markup) or decreased (negative markup) to the customers account.
\nwholesaleDiscountPercentage: Wholesale (partner) discount. Some software vendors sell partners discounted subscriptions. You in turn then mark the subscription up and sell it to your customers. It’s important to show only the retail price for the subscription to your customer, as any discounts should come from you. When you enter a discount percentage, we'll use this percentage to calculate the retail price, which is what will be billed to your customer.
\npaymentOrder: In most scenarios, you'll be billing subscriptions to your customer through AppBind. However, in some scenarios, you'll be expensing subscriptions to yourself (and presumably billing your customer separately). The paymentOrder attribute indicates who will be paying for a subscription. 0 - the customer is billed for subscription charges. 1 - the customer is billed for subscription charges, but if the customer payment source fails, your payment source will be charged (reseller is backing up the customer). 2 - you are billed for subscription charges.
\npassPaymentFees: 0 - do not pass payment fees (e.g. credit card fees) to the customer. 1 - pass payment fees to the customer.
\nshowDomain: Available for custom apps only. 1 means the application requires a domain field when logging in or signing up.
\nshowUsername: Available for custom apps only. 1 means the application requires a user name field when logging in or signing up.
\n","_postman_id":"76b34228-d618-4233-ab99-f5b12fc40eb3","auth":{"type":"bearer","bearer":{"token":"Get a catalog service.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique serviceId assigned by AppBind when the service is created.
\n","type":"text/plain"},"type":"any","value":"6ec10220-18bf-11ed-b4f1-07e2a72d0e6d","key":"catalogServiceId"}]}},"response":[{"id":"c3632606-fdea-413e-b491-bdf9ac0fc6ff","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a catalog service. Only specify those attributes you wish to change.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique serviceId assigned by AppBind when the service is created.
\n","type":"text/plain"},"type":"any","value":"6ec10220-18bf-11ed-b4f1-07e2a72d0e6d","key":"catalogServiceId"}]}},"response":[{"id":"0b857ecb-c5aa-4e7e-b752-6ac5a464840f","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get and update a catalog service by id.
\n","_postman_id":"443ce17e-a225-491c-93da-ce066898f697","auth":{"type":"bearer","bearer":{"token":"Get services in your catalog using filtering and sorting.
\n","auth":{"type":"bearer","bearer":{"token":"Either a unique service name such as Setup or a wildcard prefaced with the keyword like:set
\n","type":"text/plain"},"key":"serviceName","value":"like:mon"},{"description":{"content":"Max number of records to return
\n","type":"text/plain"},"key":"first","value":"10"},{"description":{"content":"Number of rows to offset. For example, 0 means start with the first matching row, and 10 means start with the 11th matching row.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Field to sort by. Currently only serviceName
\n","type":"text/plain"},"key":"sort","value":"serviceName"},{"description":{"content":"ASC for ascending and DESC for descending
\n","type":"text/plain"},"key":"direction","value":"DESC"}],"variable":[]}},"response":[{"id":"85354213-300b-4c93-8097-08c0ff853b5b","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreate a new service in the catalog.
\n","auth":{"type":"bearer","bearer":{"token":"A catalog service is created the first time a services is added to a subscription order. It can also be created manually. The purpose of the catalog is so that common settings can be established and defaulted for subsequent use.
\nKey related concepts:
\ncatalogServiceId: A unique identifier assigned by AppBind when the service is created.
\nappStatus: 0 (the default) means the service will be active. 1 means inactive.
\nserviceName: Name of the service as seen on subscription order.
\nbillingFrequency: 0 means billing one time only. 1 means bill monthly. This happens on the customers billing day of the month.
\nserviceAmount: Amount for this service.
\npassPaymentFees: 0 means do not pass onto customer. 1 means pass.
\n","_postman_id":"0c7bf349-417c-463e-ae4d-c9c9ff397727","auth":{"type":"bearer","bearer":{"token":"Get all subscription orders for a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"224c4295-ec35-4f5e-95ad-44efeb2989e8","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet a single subscription order.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"5beb73f5-3fc4-435d-9e3c-a9a85f74ea30","description":{"content":"(Required) This can either be a unique subscription order number or the word pending to fetch the subscription order in progress.
\n","type":"text/plain"},"type":"any","value":"","key":"orderNum"}]}},"response":[{"id":"b8bbd129-f268-401b-89d9-22bf269cd151","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerSubscription orders are used to add subscriptions, services or to increase project budget. AppBind creates a subscription order history every time a customer accepts the order. This then documents the agreement between both parties.
\n","_postman_id":"2cb23d87-de14-4c0b-871d-06edef0e0c8f","auth":{"type":"bearer","bearer":{"token":"Get all services for a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"2b1c3394-95c3-4fc7-b901-2d04c1789bfd","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet a service for a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"483f9a07-5e3a-4f42-b478-f8f122514a96","description":{"content":"(Required) Unique service Id assigned by AppBind when service is created.
\n","type":"text/plain"},"type":"any","value":"","key":"catalogServiceId"}]}},"response":[{"id":"fd13b241-0632-4979-bd1b-94575876f711","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis set of APIs allow the complete set of services to be fetched regardless of which subscription order they first appeared.
\n","_postman_id":"a5b6fd6f-fcd4-40bb-b4ab-f85349127016","auth":{"type":"bearer","bearer":{"token":"Get forwarding emails for a subscription.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"5538766c-3b56-11ed-816b-132af5073dc5","key":"customerId"},{"id":"e10c180b-ec56-4df3-869b-615260253e72","description":{"content":"(Required) Unique subscription Id assigned by AppBind when subscription is created.
\n","type":"text/plain"},"type":"any","value":"f5501a1e-3b57-11ed-bfd0-3b5a32ca6dfa","key":"subscriptionId"}]}},"response":[{"id":"d8c0a9b0-6b01-4acf-b4be-1beb6224a7cb","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate forwarding emails for a subscription.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"5538766c-3b56-11ed-816b-132af5073dc5","key":"customerId"},{"id":"9dd44858-cbc1-41fa-889c-fbb6675c100d","description":{"content":"(Required) Unique subscription Id assigned by AppBind when subscription is created.
\n","type":"text/plain"},"type":"any","value":"f5501a1e-3b57-11ed-bfd0-3b5a32ca6dfa","key":"subscriptionId"}]}},"response":[{"id":"0ca51ba2-408e-45f6-b5ff-a19c876f857c","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis set of APIs allow the forwarding email selections to be retrieved and updated.
\n","_postman_id":"649ae084-b174-4be2-a7b4-f23e81e759a5","auth":{"type":"bearer","bearer":{"token":"Get a subscription.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"cbc57472-a556-4bf0-a7df-ada97794c386","description":{"content":"(Required) Unique subscription Id assigned by AppBind when subscription is created.
\n","type":"text/plain"},"type":"any","value":"","key":"subscriptionId"}]}},"response":[{"id":"be3938bc-7bbf-4e24-98a5-b4aa66d87404","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerChange the status of a subscription.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"8282e066-e419-4233-85dc-9742798de47f","description":{"content":"(Required) Unique subscription Id assigned by AppBind when subscription is created.
\n","type":"text/plain"},"type":"any","value":"","key":"subscriptionId"}]}},"response":[{"id":"63496b36-4f1b-4d55-b637-e5381c9b3be9","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get and update subscriptions by id, and manage forwarding emails for a subscription.
\n","_postman_id":"28b62ffd-7b35-4d8c-93f0-332966b5efe2","auth":{"type":"bearer","bearer":{"token":"Get all subscriptions for a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"10fa3185-f812-4bf3-b9c2-27d46e8f2cc3","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis set of APIs allow the complete set of customer's applications to be fetched regardless of which subscription order they first appeared.
\n","_postman_id":"ee9136b9-fa89-4564-8f8c-e2091b5b59b3","auth":{"type":"bearer","bearer":{"token":"Get a user.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"acaf4d4e-a635-4938-9a5f-97cdd5dcc9d8","description":{"content":"(Required) Unique user Id assigned by AppBind when user is created.
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"f6a6292d-596d-445c-bd1c-0fd834bddff1","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a user. Both last name and first name are required.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"},{"id":"9c36b8f8-5434-4a8a-9469-24ba5e611dd8","description":{"content":"(Required) Unique user Id assigned by AppBind when user is created.
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"7fb76fc0-8402-4564-89ea-c51516dcc43f","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get and update users by id.
\n","_postman_id":"861fc97c-e5b6-4a17-8c1e-36cde6684df3","auth":{"type":"bearer","bearer":{"token":"Get all users for customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"bcf39531-3676-496d-9105-c96f87a10aba","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreate a user for a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"2961859c-317e-4668-9926-b06d0e63ca2c","name":"response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCustomer users API allow you to create, update and retrieve your customer's users. Key concepts:
\nlastName: User's last name.
\nfirstName: User's first name.
\nemail: User's email address. It must be unique.
\n","_postman_id":"16191fbd-d597-4cd0-bf5d-201fec7993ca","auth":{"type":"bearer","bearer":{"token":"Get a customer.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"1e99d089-7732-490f-841e-8952d8d409d2","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a customer. Only specify those attributes you wish to change.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"65afd792-9ab2-41b9-8c5d-c36a17f8203a","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreate a subscription order.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique customer Id assigned by AppBind when customer is created.
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[{"id":"6c1eaa03-2b2f-4d06-85c2-3b4aa1072a09","name":"response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get orders, services, and subscriptions by customer id, and can create subscription orders for a customer.
\n","_postman_id":"ea0a14db-cc1e-41d9-8046-2a9d60c8aad2","auth":{"type":"bearer","bearer":{"token":"Get customers using filtering and sorting
\n","auth":{"type":"bearer","bearer":{"token":"Either a unique customer name such as Acme or a wildcard prefaced with the keyword like:acm
\n","type":"text/plain"},"key":"customerName","value":"like:my"},{"description":{"content":"1 means only those customers that are active will be returned.
\n","type":"text/plain"},"key":"activeOnly","value":"0"},{"description":{"content":"0 means do not consider. 1 means only those customers with a balance problem will be returned.
\n","type":"text/plain"},"key":"floatProblemOnly","value":"0"},{"description":{"content":"0 means do not consider. 1 means a subscription order has not been sent to customer. 2 means there is an outstanding order. 3 means customer has accepted.
\n","type":"text/plain"},"key":"outstandingSoOnly","value":"0"},{"description":{"content":"Max number of records to return
\n","type":"text/plain"},"key":"first","value":"10"},{"description":{"content":"Number of rows to offset. For example, 0 means start with the first matching row, and 10 means start with the 11th matching row.
\n","type":"text/plain"},"key":"offset","value":"0"},{"description":{"content":"Field to sort by. Currently only customerName or customerNum
\n","type":"text/plain"},"key":"sort","value":"customerNum"},{"description":{"content":"ASC for ascending and DESC for descending
\n","type":"text/plain"},"key":"direction","value":"DESC"}],"variable":[]}},"response":[{"id":"a4f77332-5814-4d1b-b3f6-f99c1d319ee3","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerCreate a customer.
\n","auth":{"type":"bearer","bearer":{"token":"A customer represents any business or entity for which you manage subscriptions and provide services. If you want to automate creation of customers in AppBind when you add a customer to a CRM (or other existing system you use to manage your customers), you'll likely be calling the \"create customer\" endpoint, and then saving the returned AppBind customer id for use in subseqeunt calls (e.g. create and send subscription order). Key concepts:
\ncustomerName: Customer name.
\ncustomerNum: Customer number/id/designation you use to identify a customer separate from the customer name.
\ndescription: General description.
\ncustomerStatus: 0 means active. 1 means suspended.
\ncontactEmail: Main contact email account.
\ncontactFirstName: Main contact first name.
\ncontactLastName: Main contact last name.
\naddress1: Company address line 1.
\naddress2: Company address line 2 if applicable.
\ncity: Company city.
\nstate: Company state.
\ncountry: Company country.
\npostalCode: Company postalCode.
\nmaxMonthlyBudget: Maximum that can be charged in a month.
\nautoTopupThreshold: Threshold upon which additional funds will be captured.
\nautoTopupAmount: Ongoing topup amount when threshold is reached.
\n","_postman_id":"fc7f5bbd-4ce6-409a-b331-3a9e92ed86b6","auth":{"type":"bearer","bearer":{"token":"Get a user.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique user Id assigned by AppBind when user is created.
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"1a48bbee-ee24-4927-9968-bd1adff4d4b2","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerUpdate a user. Both last name and first name are required.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique user Id assigned by AppBind when user is created.
\n","type":"text/plain"},"type":"any","value":"","key":"userId"}]}},"response":[{"id":"7535b63b-3a2b-49a1-9699-a20d90c3ca3d","name":"response","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerYou can get and update individual users.
\n","_postman_id":"908ec005-b556-4a20-9b9f-4a0958cb84cc","auth":{"type":"bearer","bearer":{"token":"Get all users for your organization.
\n","auth":{"type":"bearer","bearer":{"token":"Create a user.
\n","auth":{"type":"bearer","bearer":{"token":"This users resource represents users on your own team.
\nKey concepts:
\nlastName: User's last name.
\nfirstName: User's first name.
\nemail: User's email address. It must be unique.
\n","_postman_id":"14a8755a-a8f7-429c-af8b-5863da8abb04","auth":{"type":"bearer","bearer":{"token":"Get a subscription order.
\n","auth":{"type":"bearer","bearer":{"token":"(Required) Unique subscription order number assigned by AppBind when subscription order is accepted.
\n","type":"text/plain"},"type":"any","value":"","key":"orderNumber"}]}},"response":[{"id":"a570c90c-d9cb-4ec8-8d95-060126b10dac","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer