{ "opencollection": "1.0.0", "info": { "name": "Subskribe API", "version": "1.0.0" }, "request": { "auth": { "type": "apikey", "key": "X-API-Key", "value": "{{X-API-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Billing", "type": "folder" }, "items": [ { "info": { "name": "Get the contact for accounts receivable", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accountReceivableContact" }, "docs": "Returns the details of the account receivable contact for your tenant" }, { "info": { "name": "Set the contact for accounts receivable", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accountReceivableContact", "body": { "type": "json", "data": "{}" } }, "docs": "Sets the details of the account receivable contact for your tenant" }, { "info": { "name": "Get the details of an alias", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/alias/subscriptionCharge/:aliasId", "params": [ { "name": "aliasId", "value": "", "type": "path" } ] }, "docs": "Returns the details of the specified alias id including the subscription id and the charge id it is mapped to." }, { "info": { "name": "Create an alias for a subscription id/charge id pair", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/alias/subscriptionCharge/:aliasId", "params": [ { "name": "aliasId", "value": "", "type": "path", "description": "alias to map to create the mapping for" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "the subscription id" }, { "name": "chargeId", "value": "", "type": "query", "description": "the charge id" } ] }, "docs": "This allows you to specify a string alias for a subscription id and a charge id. This can be useful when, for example, you want to upload usage statistics and would rather specify your own id (or another external id), rather than referring to Subskribe's internal ids." }, { "info": { "name": "Delete the specified alias", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/alias/subscriptionCharge/:aliasId", "params": [ { "name": "aliasId", "value": "", "type": "path" } ] }, "docs": "Deletes the specified alias mapping" }, { "info": { "name": "Get aliases for a subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/alias/subscriptionCharge", "params": [ { "name": "subscriptionId", "value": "", "type": "query", "description": "id of the subscription" } ] }, "docs": "Returns all aliases for the specified subscription id." }, { "info": { "name": "Get automated invoice rule details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/automatedInvoiceRules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of the automated invoice rule" } ] }, "docs": "Returns the details of the specified automated invoice rule" }, { "info": { "name": "Update automated invoice rule details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/automatedInvoiceRules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the automated invoice rule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified automated invoice rule" }, { "info": { "name": "Get automated invoice rule details via internal id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/automatedInvoiceRules/internal/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Internal id of the automated invoice rule" } ] }, "docs": "Returns the details of the specified automated invoice rule" }, { "info": { "name": "updateAutomatedInvoiceRuleUsingInternalId", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/automatedInvoiceRules/internal/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the automated invoice rule" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Get automated invoice rules for a tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/automatedInvoiceRules" }, "docs": "Returns all the configured automated invoice rules for the tenant" }, { "info": { "name": "Create an automated invoice rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/automatedInvoiceRules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an automated invoice rule with the specified parameters" }, { "info": { "name": "Send an Invoice Reminder", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/dunning/sendInvoiceReminder/:invoiceNumber", "params": [ { "name": "invoiceNumber", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Sends a reminder email for the specified invoice" }, { "info": { "name": "Send a test email", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/dunning/sendTestEmail/:reminderType", "params": [ { "name": "reminderType", "value": "", "type": "path", "description": "type of the reminder" } ] }, "docs": "Sends a test email for dunning to the use associated with this API call. Note A user bound api key is required for this operation." }, { "info": { "name": "Get dunning settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/dunningSetting" }, "docs": "Returns the dunning settings for your tenant" }, { "info": { "name": "Update dunning settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/dunningSetting", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the dunning settings for your tenant" }, { "info": { "name": "Get bulk invoice run details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/bulk/:bulkInvoiceRunId", "params": [ { "name": "bulkInvoiceRunId", "value": "", "type": "path", "description": "id of the run" } ] }, "docs": "Returns the details of the specified bulk invoice run" }, { "info": { "name": "Get items for bulk invoice run", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/bulk/:bulkInvoiceRunId/runItems", "params": [ { "name": "bulkInvoiceRunId", "value": "", "type": "path", "description": "id of the run" } ] }, "docs": "Returns the items associated with the specified bulk invoice run" }, { "info": { "name": "Get invoice balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/:number/balance", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Returns the balance of the specified invoice number" }, { "info": { "name": "Get invoice details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/:number", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" }, { "name": "includeDeleted", "value": "", "type": "query", "description": "include deleted invoice items" } ] }, "docs": "Returns the details of the specified invoice number" }, { "info": { "name": "Update invoice details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/invoices/:number", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified invoice." }, { "info": { "name": "Delete invoice", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/invoices/:number", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Deletes the specified invoice" }, { "info": { "name": "Generate subscription invoices", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/generate", "params": [ { "name": "subscriptionId", "value": "", "type": "query", "description": "id of the subscription" }, { "name": "targetDate", "value": "", "type": "query", "description": "Time in seconds since Epoch (GMT) to generate invoice from" }, { "name": "invoiceDate", "value": "", "type": "query", "description": "Time in seconds since Epoch (GMT) to set invoice date to" }, { "name": "invoiceChargeInclusionOption", "value": "", "type": "query", "description": "types of charges to include" } ] }, "docs": "Generates the invoices for the given subscription" }, { "info": { "name": "Preview invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/preview", "params": [ { "name": "orderId", "value": "", "type": "query", "description": "id of order" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "id of subscription" } ] }, "docs": "Returns a preview of invoice for the specified order id OR subscription id" }, { "info": { "name": "Get unbilled usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/unbilledUsage", "params": [ { "name": "subscriptionId", "value": "", "type": "query", "description": "id of the subscription" } ] }, "docs": "Returns the unbilled usage invoice items for the specified subscription" }, { "info": { "name": "Get all invoices for a subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices", "params": [ { "name": "subscriptionId", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query", "description": "status filter for invoices" }, { "name": "cursor", "value": "", "type": "query", "description": "used to iterate through all results" }, { "name": "limit", "value": "", "type": "query", "description": "number of items per page" } ] }, "docs": "Returns all invoices for a subscription. The result is paginated. Use the cursor returned from a request in subsequent calls to retrieve all results." }, { "info": { "name": "Delete voided invoice", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/invoices/:number/voided", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Deletes the specified invoice" }, { "info": { "name": "Mark invoice as posted", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/:number/post", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Marks the specified invoice as posted" }, { "info": { "name": "Mark invoice as voided", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/invoices/:number/void", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Marks the specified invoice as voided" }, { "info": { "name": "Download invoice PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/:invoiceNumber/pdf", "params": [ { "name": "invoiceNumber", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Downloads the PDF for an invoice after it has been generated via a POST to /{invoiceNumber}/pdf. The data return will be the PDF document contents." }, { "info": { "name": "Generate invoice PDF", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/:invoiceNumber/pdf", "params": [ { "name": "invoiceNumber", "value": "", "type": "path" }, { "name": "force", "value": "", "type": "query", "description": "Force regeneration of the PDF document even if there has been no changes. Defaults to false." } ] }, "docs": "Generates a PDF version of the specified invoice. Once generated, PDF can be later fetched via a call to /{invoiceNumber}/pdf." }, { "info": { "name": "Delete an existing billing schedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/invoices/schedule/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "billing schedule entry id" } ] }, "docs": "Billing schedules must be deleted in reverse chronological order." }, { "info": { "name": "Get billing schedules for a subscription line item", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/schedule", "params": [ { "name": "subscriptionId", "value": "", "type": "query" }, { "name": "subscriptionChargeId", "value": "", "type": "query" } ] }, "docs": "Retrieve all billing schedules for a subscription line item" }, { "info": { "name": "Add a new billing schedule for subscription line item", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/schedule", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new billing schedule entry for an event based charge" }, { "info": { "name": "Posts invoices for a bulk run", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/invoices/bulk/:bulkInvoiceRunId/post", "params": [ { "name": "bulkInvoiceRunId", "value": "", "type": "path", "description": "id of the run" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Marks all invoices associated with the specified bulk run as posted" }, { "info": { "name": "Send emails for multiple invoices", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/bulk/email", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger tasks for sending emails for the given list of invoice IDs" }, { "info": { "name": "Update invoice sequence", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/sequence/:invoiceConfigId", "params": [ { "name": "invoiceConfigId", "value": "", "type": "path", "description": "invoice config id" }, { "name": "next invoice number", "value": "", "type": "query", "description": "long integer value" } ] }, "docs": "Updates the invoice sequence by invoice config id." }, { "info": { "name": "Preview all invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/previewAllInvoices", "params": [ { "name": "orderId", "value": "", "type": "query", "description": "id of order" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "id of subscription" } ] }, "docs": "Returns a preview of invoice for the specified order id OR subscription id" }, { "info": { "name": "Get usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/usage", "params": [ { "name": "subscriptionId", "value": "", "type": "query", "description": "id of the subscription" }, { "name": "chargeId", "value": "", "type": "query", "description": "id of the charge" } ] }, "docs": "Returns the usage invoice items for the specified subscription and charge" }, { "info": { "name": "Check if invoice can be deleted", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/:number/canDelete", "params": [ { "name": "number", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Response contains flag to indicate if the invoice can be deleted and reason if it cannot be deleted" }, { "info": { "name": "Get the invoice document JSON that is used to render invoice PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/invoices/:invoiceNumber/documentJson", "params": [ { "name": "invoiceNumber", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Invoice document JSON that contains all details required to render full Invoice document" }, { "info": { "name": "Send invoice email to contacts", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/:invoiceNumber/email", "params": [ { "name": "invoiceNumber", "value": "", "type": "path" } ] }, "docs": "Send the invoice to recipients via email with invoice PDF as attachment." }, { "info": { "name": "Create a bulk invoice run", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/invoices/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a bulk invoice run as specified by the input parameters. On success the id of the run is returned." }, { "info": { "name": "Get applicable payment bank accounts for invoice payment", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settlements/applicablePaymentBankAccounts", "params": [ { "name": "invoiceNumber", "value": "", "type": "query", "description": "Invoice number" } ] }, "docs": "Returns a list of applicable payment bank accounts that can be used for payment for a given invoice number" }, { "info": { "name": "Get settlement application details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settlements/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the settlement application" } ] }, "docs": "Gets the details of specified settlement application." }, { "info": { "name": "Get settlement applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settlements", "params": [ { "name": "invoiceNumber", "value": "", "type": "query", "description": "number of the invoice" }, { "name": "paymentId", "value": "", "type": "query", "description": "Id of payment" } ] }, "docs": "Returns the settlement applications for the specified invoice number or payment object." }, { "info": { "name": "Apply a payment on a specific invoice", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settlements/addAndApplyPayment", "body": { "type": "json", "data": "{}" } }, "docs": "Apply a payment per the specified parameters." }, { "info": { "name": "Apply a credit memo", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settlements/applyCreditMemo", "body": { "type": "json", "data": "{}" } }, "docs": "Applies a credit memo per the specified parameters" }, { "info": { "name": "Unapply a credit memo", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settlements/unapplyCreditMemo", "body": { "type": "json", "data": "{}" } }, "docs": "Unapplies a credit memo per the specified parameters" } ] }, { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Get all accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A string token is used to fetch next set of results. If not provided, the first page of results will be returned. Use the 'next_cursor' value from the previous response to fetch the next page." }, { "name": "limit", "value": "", "type": "query", "description": "An integer specifying the maximum number of results to return per page. Defaults to 10 if not provided." }, { "name": "type", "value": "", "type": "query", "description": "The type of accounts to retrieve. Allowed values are: ALL: Includes all account types. RESELLER: Includes only reseller accounts. NON_RESELLER: Includes only non-reseller accounts." } ] }, "docs": "Returns a paginated list of accounts" }, { "info": { "name": "Add a new account", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accounts", "body": { "type": "json", "data": "{}" } }, "docs": "Create an account with the specified parameters. On success, the id of the newly created account is returned" }, { "info": { "name": "Get an account by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Account" }, { "name": "idType", "value": "", "type": "query", "description": "Specifies the type of ID being used. Allowed values are account_id: The default account ID. crm_id: The CRM (Customer Relationship Management) ID external_id: An external system's ID for the account. Default is account_id" } ] }, "docs": "Retrieves detailed information about a specific account using its unique identifier. It could be Account_ID, CRM_ID or External_ID. This endpoint provides comprehensive data for a particular account, enabling users to access full account details." }, { "info": { "name": "Update an account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing account with the specified parameters" }, { "info": { "name": "Delete an account", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/accounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes the account associated with the passed ID" }, { "info": { "name": "Get contacts for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:accountId/contacts", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Uniquely identifies the account for which contacts are being retrieved." }, { "name": "expand", "value": "", "type": "query", "description": "When set to true, expands the response to include additional details about each contact, such as address, external id, erp id, fullName. Default is false." } ] }, "docs": "Returns a list of contacts associated with the specified account id" }, { "info": { "name": "Add a contact for an account", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accounts/:accountId/contacts", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "value = Uniquely identifies the account" }, { "name": "skipAddressValidation", "value": "", "type": "query", "description": "value = perform basic address validation" }, { "name": "strictValidation", "value": "", "type": "query", "description": "value = require the address to match a canonical address, if it exists" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and adds a new contact for the specified account and returns the new contact ID." }, { "info": { "name": "Update CRM ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accounts/:accountId/crmId", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "API to update CRM ID for an account" }, { "info": { "name": "Returns metrics for the specified account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "targetDate", "value": "", "type": "query" }, { "name": "forceRecalculate", "value": "", "type": "query" } ] }, "docs": "Fetches metrics such as ARR, TCV, etc for the specified account as of the specified target date" }, { "info": { "name": "Get the details of a payment method", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:accountId/paymentMethods/:id", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns the details of the payment method for the specified account id and payment method id" }, { "info": { "name": "Update account ERP details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accounts/:accountId/erp", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "value = Uniquely identifies the account" }, { "name": "override", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update ERP details for an account specified by the account id" }, { "info": { "name": "Gets contact details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:accountId/contacts/:contactId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Uniquely identifies the account for which contacts are being retrieved." }, { "name": "contactId", "value": "", "type": "path", "description": "Uniquely identifies the contact." } ] }, "docs": "Returns the details of the specified contact" }, { "info": { "name": "Update a contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accounts/:accountId/contacts/:contactId", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "contactId", "value": "", "type": "path" }, { "name": "skipAddressValidation", "value": "", "type": "query" }, { "name": "strictValidation", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the contact specified by the account id and contact id with the passed information" }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/accounts/:accountId/contacts/:contactId", "params": [ { "name": "contactId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "Deletes the contact specified by the account id and contact id" }, { "info": { "name": "Import an account from a CRM", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accounts/crm/import", "body": { "type": "json", "data": "{}" } }, "docs": "Ensures an account exists which matches the passed details.If an account exists that has a matching CRM Id, it will be updated, if not, it will be created" }, { "info": { "name": "Get account payment configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/:accountId/paymentConfig", "params": [ { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "Retrieves the payment configuration for the specified account" }, { "info": { "name": "Upsert account payment configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accounts/:accountId/paymentConfig", "params": [ { "name": "accountId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the payment configuration for the specified account" } ] }, { "info": { "name": "Intelligent Sales Room", "type": "folder" }, "items": [ { "info": { "name": "Get account contacts via sales room share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounts/salesRoom/:shareLink/contacts", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Gets account contacts via sales room share link" }, { "info": { "name": "Create account contact via share link", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accounts/salesRoom/:shareLink/contacts", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "skipAddressValidation", "value": "", "type": "query", "description": "value = perform basic address validation" }, { "name": "strictValidation", "value": "", "type": "query", "description": "value = require the address to match a canonical address, if it exists" }, { "name": "addToReseller", "value": "", "type": "query", "description": "value = Whether or not to add the contact for the reseller" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates account contact via share link" }, { "info": { "name": "Update account contact via share link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/accounts/salesRoom/:shareLink/contacts/:contactId", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "contactId", "value": "", "type": "path" }, { "name": "skipAddressValidation", "value": "", "type": "query", "description": "value = perform basic address validation" }, { "name": "strictValidation", "value": "", "type": "query", "description": "value = require the address to match a canonical address, if it exists" }, { "name": "updateReseller", "value": "", "type": "query", "description": "value = Whether or not to update the contact for the reseller" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates account contact via share link" }, { "info": { "name": "Generate a composite order PDF via Sales Room Share Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/compositeOrders/salesRoom/:shareLink/pdf", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Generate and retrieve a PDF representation of the composite order details for a specific sales room using share link." }, { "info": { "name": "Delete a file", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/files/:fileId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "fileId", "value": "", "type": "path" } ] }, "docs": "Deletes an uploaded file" }, { "info": { "name": "Get all files for a sales room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/files", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "category", "value": "", "type": "query" } ] }, "docs": "Returns all uploaded files" }, { "info": { "name": "Upload a file", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/files", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "originalFileName", "type": "text", "value": "" }, { "name": "fileSize", "type": "text", "value": "" }, { "name": "contentType", "type": "text", "value": "" }, { "name": "category", "type": "text", "value": "" } ] } }, "docs": "Uploads a file to the sales room" }, { "info": { "name": "Create a new intelligent sales room", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms", "params": [ { "name": "orderId", "value": "", "type": "query" } ] }, "docs": "Creates a new sales room for the specified order" }, { "info": { "name": "Get sales room by order ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/by-order/:orderId", "params": [ { "name": "orderId", "value": "", "type": "path" } ] }, "docs": "Returns the sales room for the specified order, creating one if it doesn't exist" }, { "info": { "name": "Get sales room by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns the sales room details" }, { "info": { "name": "Update a widget", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets/:widgetId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "widgetId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates widget name and content" }, { "info": { "name": "Delete a widget", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets/:widgetId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "widgetId", "value": "", "type": "path" } ] }, "docs": "Deletes a user-generated widget" }, { "info": { "name": "Reorder widgets", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets/reorder", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the sort order of all widgets" }, { "info": { "name": "Get sales room theme", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/theme", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns the current theme settings" }, { "info": { "name": "Update theme manually", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/theme", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates theme with user-provided values" }, { "info": { "name": "Generate AI content for widget", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets/:widgetId/ai-content", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "widgetId", "value": "", "type": "path" } ] }, "docs": "Generates AI content based on order context" }, { "info": { "name": "Update AI generated content", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/ai-content/:contentId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "contentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates AI content with user edits" }, { "info": { "name": "Activate sales room", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/activate", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Moves sales room from READY_TO_SHARE to ACTIVE status" }, { "info": { "name": "Retract sales room", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/retract", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Moves sales room from ACTIVE to READY_TO_SHARE status" }, { "info": { "name": "Accept sales room proposal (using share link)", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/accept", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Moves sales room (using share link) to ACCEPTED status" }, { "info": { "name": "Accept sales room proposal", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/accept", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Moves sales room to ACCEPTED status" }, { "info": { "name": "Get engagement summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/engagement/summary", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "toDate", "value": "", "type": "query" } ] }, "docs": "Returns engagement metrics and summary" }, { "info": { "name": "Get activity logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/engagement/activity", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "toDate", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of records to return" }, { "name": "pageToken", "value": "", "type": "query", "description": "Page token for pagination" } ] }, "docs": "Returns activity logs with optional date filtering and pagination" }, { "info": { "name": "Get share link access records", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/share-access", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns all users who have accessed via share link" }, { "info": { "name": "Get unique visitor count", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/visitors/count", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns the number of unique visitors" }, { "info": { "name": "Update customer information", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/customer-information", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates billing and/or shipping contact information" }, { "info": { "name": "Fetch custom fields for an Intelligent Sales Room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/custom-fields", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Retrieves the custom fields for the specified Intelligent Sales Room." }, { "info": { "name": "Update custom fields for an Intelligent Sales Room", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/custom-fields", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the custom fields for the specified Intelligent Sales Room." }, { "info": { "name": "Track user event", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/events", "params": [ { "name": "shareLink", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Records user interaction events" }, { "info": { "name": "Fetch custom fields for an Intelligent Sales Room (via share link)", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/custom-fields", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Retrieves the custom fields for the specified Intelligent Sales Room (via share link)." }, { "info": { "name": "Update custom fields for an Intelligent Sales Room (via share link)", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/custom-fields", "params": [ { "name": "shareLink", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the custom fields for the specified Intelligent Sales Room (via share link)." }, { "info": { "name": "Get all widgets for a sales room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns all widgets ordered by sort order" }, { "info": { "name": "Create a new widget", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/widgets", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user-generated widget with type-specific content structure.\n\nContent format by widget type:\n- RICH_TEXT: {\"html\": \"HTML content\"}\n- AI_GENERATED_TEXT: {} (empty object - content is generated by calling the AI generation endpoint after widget creation)\n- MEDIA_CONTENT: {\"type\": \"YOUTUBE_VIDEO|LINK|FILE_UPLOAD|GOOGLE_WORKSPACE|PDF_UPLOAD\", \"url\": \"...\", \"fileId\": \"...\", \"title\": \"...\"}\n- USER_PDF: {\"fileId\": \"uploaded-file-uuid\"}\n\nMedia content types:\n- YOUTUBE_VIDEO: YouTube video U" }, { "info": { "name": "Extract theme from website", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/theme/extract", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Automatically extracts branding from website using AI" }, { "info": { "name": "Get file download URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/:salesRoomId/files/:fileId/download", "params": [ { "name": "salesRoomId", "value": "", "type": "path" }, { "name": "fileId", "value": "", "type": "path" }, { "name": "expirationMinutes", "value": "", "type": "query", "description": "URL expiration in minutes" } ] }, "docs": "Returns a presigned URL for file download" }, { "info": { "name": "Fetch order form PDF for an Intelligent Sales Room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/order/pdf", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Downloads the order form PDF for the specified Intelligent Sales Room." }, { "info": { "name": "Access sales room via share link", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/access", "params": [ { "name": "shareLink", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "End-user access to sales room using share link" }, { "info": { "name": "Get widgets via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/widgets", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "End-user access to sales room widgets" }, { "info": { "name": "Get theme via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/theme", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "End-user access to sales room theme" }, { "info": { "name": "Get files via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/files", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "category", "value": "", "type": "query" } ] }, "docs": "End-user access to sales room files" }, { "info": { "name": "Get file download URL via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/files/:fileId/download", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "fileId", "value": "", "type": "path" }, { "name": "expirationMinutes", "value": "", "type": "query", "description": "URL expiration in minutes" } ] }, "docs": "End-user access to file download" }, { "info": { "name": "Get sales room details via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "End-user access to basic sales room information" }, { "info": { "name": "Get AI content via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/ai-content", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "End-user access to AI generated content" }, { "info": { "name": "Update customer information via share link", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/customer-information", "params": [ { "name": "shareLink", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "End-user update of customer information via share link" }, { "info": { "name": "Download image file via share link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/image/:fileName", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "fileName", "value": "", "type": "path" } ] }, "docs": "Downloads image file for public access" }, { "info": { "name": "Send email for e-signature via share link", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/esign", "params": [ { "name": "shareLink", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends email for eSign for Sales Room via share link" }, { "info": { "name": "Fetch order metadata for an Intelligent Sales Room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/intelligent-sales-rooms/share/:shareLink/order-metadata", "params": [ { "name": "shareLink", "value": "", "type": "path" } ] }, "docs": "Retrieves the corder metadata for the specified Intelligent Sales Room." }, { "info": { "name": "Generate an order PDF via Sales Room Share Link", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/orders/salesRoom/:shareLink/pdf", "params": [ { "name": "shareLink", "value": "", "type": "path" }, { "name": "force", "value": "", "type": "query", "description": "Force regeneration of the PDF document even if there has been no changes. Defaults to false." } ] }, "docs": "Generate and retrieve a PDF representation of the order details for a specific sales room using share link." } ] }, { "info": { "name": "Accounting", "type": "folder" }, "items": [ { "info": { "name": "Specify the current accounting period", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/accountingPeriods", "body": { "type": "json", "data": "{}" } }, "docs": "Specify the start date of and open an accounting period, making it current" }, { "info": { "name": "Get the current accounting period", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accountingPeriods/current" }, "docs": "Get the current accounting period" }, { "info": { "name": "Return Journal Entry summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounting/journalEntry/summary", "params": [ { "name": "accountingPeriodId", "value": "", "type": "query", "description": "Id of the period" } ] }, "docs": "Returns Journal Entry summary for the optionally specified accounting period as text/csv. If no period is specified, Journal Entry summary for 12 recent periods are returned." }, { "info": { "name": "Get running balances of revenue schedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounting/journalEntry/runningBalances", "params": [ { "name": "scheduleId", "value": "", "type": "query", "description": "Revenue schedule id" }, { "name": "asOf", "value": "", "type": "query", "description": "Date in seconds since Epoch(GMT)" } ] }, "docs": "Returns deferred revenue and contract asset balances for the given revenue schedule, as of the given date.If no date is provided, the balances are returned as of the current date." }, { "info": { "name": "Get accounting events for the specified dates", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounting/journalEntry/events", "params": [ { "name": "from", "value": "", "type": "query", "description": "start date in seconds since Epoch(GMT)" }, { "name": "to", "value": "", "type": "query", "description": "end date in seconds since Epoch(GMT)" }, { "name": "limit", "value": "", "type": "query", "description": "number of items per page" }, { "name": "pageToken", "value": "", "type": "query", "description": "pass this to subsequent calls" } ] }, "docs": "Returns all accounting related events between the from and to dates. Since there can be a large number of these, the results are paginated. To retrieve subsequent pages of events, pass in the pageToken returned from the prior call." }, { "info": { "name": "Return Journal Entries", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounting/journalEntry", "params": [ { "name": "accountingPeriodId", "value": "", "type": "query", "description": "Id of the period" } ] }, "docs": "Returns all Journal Entries for the optionally specified accounting period as text/csv. If no period is specified, Journal Entries for 12 recent periods are returned." }, { "info": { "name": "Get ledger accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/accounting/ledgerAccounts", "params": [ { "name": "type", "value": "", "type": "query", "description": "Filter by ledger account type" } ] }, "docs": "Get list of all ledger accounts (GL accounts), optionally filtered by type" } ] }, { "info": { "name": "AI Agent", "type": "folder" }, "items": [ { "info": { "name": "Generate zeppa artifact based on the description provided", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/ai/zeppa/gen" }, "docs": "Generate zeppa code or documentation based on the input provided" }, { "info": { "name": "Get the agent session given the id, NOTE: at the moment there is no response body", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/agents/session/:sessionId", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "id of the session to be fetched" } ] }, "docs": "Get the agent session given the id, NOTE: at the moment there is no response body, if 200 is returned then session exists" }, { "info": { "name": "Generate a summary of the subscription in plain english in markdown format", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/summary/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "id of the subscription" } ] }, "docs": "Generate a complete summary of the subscription with the given id, a full detailed summary will be generated including metrics" }, { "info": { "name": "Create new conversational AI agent session", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/ai/agents/session" }, "docs": "Create a new conversation session with Subskribe AI agent, this resource will return a session id which will be used for future conversations" }, { "info": { "name": "Chat with a given session id and get back a response for a given message", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/ai/agents/session/:sessionId/chat", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "id of the session with which the conversation needs to happen" } ] }, "docs": "The API responds user message, a session id is required to identify the session this message needs to be posted" }, { "info": { "name": "Chat with a given session id and get back a response for a given message in a async manner in the form of server side events", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/agents/session/:sessionId/chatAsync", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "id of the session with which the conversation needs to happen" }, { "name": "userMessage", "value": "", "type": "query", "description": "the user message to which the AI can respond" } ] }, "docs": "The API responds to user message, a session id is required to identify the session this message needs to be posted" }, { "info": { "name": "List the messages belong to this session", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/agents/session/:sessionId/messages", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "id of the session with which the conversation needs to happen" }, { "name": "limit", "value": "", "type": "query", "description": "the number of message to fetch should be a number between 1 to 100 if present" } ] }, "docs": "The message will be returned in the most recent order, with the latest being the first" } ] }, { "info": { "name": "AI Summary", "type": "folder" }, "items": [ { "info": { "name": "Generate an explanation of the proration calculation", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/explain/proration/async/:orderId/:orderLineItemId", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "id of the order" }, { "name": "orderLineItemId", "value": "", "type": "path", "description": "id of the order line item" } ] }, "docs": "Generate an explanation of the proration calculation for the given order line item." }, { "info": { "name": "Generate an explanation of the proration calculation", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/explain/proration/:orderId/:orderLineItemId", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "id of the order" }, { "name": "orderLineItemId", "value": "", "type": "path", "description": "id of the order line item" } ] }, "docs": "Generate an explanation of the proration calculation for the given order line item." }, { "info": { "name": "Generate a summary of the order in plain english in markdown format", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ai/summary/order/:orderId", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "id of the order" }, { "name": "type", "value": "", "type": "query", "description": "Force regeneration of the PDF document even if there has been no changes. Defaults to false." } ] }, "docs": "Generate a complete summary of the order with the given id, a full detailed summary will be generated including metrics" } ] }, { "info": { "name": "Integrations", "type": "folder" }, "items": [ { "info": { "name": "Add a Anrok integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/anrok", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the integration ID if successful" }, { "info": { "name": "Test an integration is valid", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/anrok/test", "body": { "type": "json", "data": "{}" } }, "docs": "Test an integration is valid" }, { "info": { "name": "Validate an address with Anrok", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/anrok/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Validate an address with Anrok" }, { "info": { "name": "Get integration details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/anrok/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integration id" } ] }, "docs": "Gets the integration details of the specified integration id" }, { "info": { "name": "Pings Avalara", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/avalara/ping", "body": { "type": "json", "data": "{}" } }, "docs": "Once an integration is set up Avalara can be pinged to ensure it is working correctly. On success \"PONG\" is returned." }, { "info": { "name": "Gets Avalara integration details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/avalara/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integration id" } ] }, "docs": "Gets the integration details of the specified integration id" }, { "info": { "name": "Gets Avalara integration details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/avalara" }, "docs": "Returns the details of the Avalara integration for your tenant" }, { "info": { "name": "Create an Avalara integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/avalara", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an integration with Avalara according to the specified details. On success the id of the integration is returned" }, { "info": { "name": "Opportunity name change notification", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/crm/:opportunityCrmId/notifyNameChange", "params": [ { "name": "opportunityCrmId", "value": "", "type": "path", "description": "crm id of the opportunity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Subskribe is notified for the opportunity name change happening in Crm systems. This is used to update the opportunity name in Subskribe." }, { "info": { "name": "Fetch all associated CRM contacts for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crm/:accountId/contacts", "params": [ { "name": "accountId", "value": "", "type": "path" } ] }, "docs": "Fetch all associated CRM contacts for an account" }, { "info": { "name": "Upsert CRM contacts for an account", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/crm/contacts", "body": { "type": "json", "data": "{}" } }, "docs": "Upsert CRM contacts for an account" }, { "info": { "name": "Complete Docusign integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/docusign", "params": [ { "name": "code", "value": "", "type": "query", "description": "authorization code received from Docusign" }, { "name": "state", "value": "", "type": "query", "description": "id of the integration" } ] }, "docs": "Complete the docusign integration. This should be called after the integration has been created and an authorization code has been received from Docusign." }, { "info": { "name": "Create Docusign integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/docusign", "body": { "type": "json", "data": "{}" } }, "docs": "Creates an integration with Docusign. On success a redirect URL is returned." }, { "info": { "name": "Delete Docusign integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/docusign" }, "docs": "Removes integration with Docusign from your tenant" }, { "info": { "name": "Re-authenticate Docusign integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/docusign/reauthenticate" }, "docs": "Generates a fresh DocuSign authorization URL for the existing integration so an administrator can re-authenticate." }, { "info": { "name": "Handle HubSpot authorization code", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/hubspot", "params": [ { "name": "code", "value": "", "type": "query", "description": "authorization code" }, { "name": "state", "value": "", "type": "query", "description": "HubSpot integration id" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "uri to redirect to HubSpot" } ] }, "docs": "Endpoint to handle and process a HubSpot authorization code" }, { "info": { "name": "Initiate a HubSpot integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot", "body": { "type": "json", "data": "{}" } }, "docs": "Initiates an integration with HubSpot. On success redirect URL is returned." }, { "info": { "name": "Delete HubSpot Integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/hubspot" }, "docs": "Deletes your integration with HubSpot." }, { "info": { "name": "Add custom properties to HubSpot", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/setup" }, "docs": "Add custom properties to HubSpot" }, { "info": { "name": "Verify HubSpot setup", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/setup/verify" }, "docs": "Verify custom objects and properties" }, { "info": { "name": "Sync esign details for order id", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/esign/:orderId", "params": [ { "name": "orderId", "value": "", "type": "path" } ] }, "docs": "Sync esign details for order id" }, { "info": { "name": "Sync order to Hubspot", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/sync/order/:orderId", "params": [ { "name": "orderId", "value": "", "type": "path" } ] }, "docs": "Sync order to Hubspot" }, { "info": { "name": "Import account from HubSpot", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/sync/account/:accountCrmId", "params": [ { "name": "accountCrmId", "value": "", "type": "path" } ] }, "docs": "Import account from HubSpot" }, { "info": { "name": "Sync subscription to Hubspot", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/sync/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path" } ] }, "docs": "Sync subscription to Hubspot" }, { "info": { "name": "Sync subscription status to Hubspot", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/hubspot/sync/subscription/:subscriptionId/status", "params": [ { "name": "subscriptionId", "value": "", "type": "path" } ] }, "docs": "Sync subscription status to Hubspot" }, { "info": { "name": "Callback for the authorization code", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/sfdc", "params": [ { "name": "code", "value": "", "type": "query", "description": "authorization code" }, { "name": "state", "value": "", "type": "query", "description": "id of the integration" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "uri to redirect to" } ] }, "docs": "Handles the authorization code callback from Salesforce" }, { "info": { "name": "Initiate integration with Salesforce", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/sfdc", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate a Salesforce integration. On success a redirect url is returned." }, { "info": { "name": "Delete Salesforce integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/sfdc" }, "docs": "Removes the Salesforce integration for the tenant." }, { "info": { "name": "Get Salesforce accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/sfdc/account", "params": [ { "name": "name", "value": "", "type": "query", "description": "account name" } ] }, "docs": "Returns Salesforce accounts matching the specified name." }, { "info": { "name": "Import account from Salesforce", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/sfdc/account", "body": { "type": "json", "data": "{}" } }, "docs": "Imports an account from Salesforce. On success a redirect uri is returned." }, { "info": { "name": "Get Salesforce account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/sfdc/account/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the account" } ] }, "docs": "Gets a Salesforce account by its id." }, { "info": { "name": "Make an order primary", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/order/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "order id" } ] }, "docs": "Marks an order as the primary order for its opportunity." }, { "info": { "name": "Get Salesforce opportunities", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/sfdc/opportunity", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "id of the account" } ] }, "docs": "Returns the Salesforce opportunities associated withe the specified account." }, { "info": { "name": "Sync order to Salesforce", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/sync/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "order id" } ] }, "docs": "Syncs the specified order to Salesforce." }, { "info": { "name": "Sync orders to Salesforce", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/syncOrders", "body": { "type": "json", "data": "{}" } }, "docs": "Syncs the specified order to Salesforce." }, { "info": { "name": "Sync whole tenant to Salesforce in a paginated fashion", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/syncTenant", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "tenantId", "value": "", "type": "query" } ] }, "docs": "Syncs the specified tenant to Salesforce. Returns paginated JSON of accounts which were synced" }, { "info": { "name": "Sync orders to Salesforce", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/syncDeletedOrders", "body": { "type": "json", "data": "{}" } }, "docs": "Syncs the specified order to Salesforce." }, { "info": { "name": "Sync an account to Salesforce", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/syncAccount/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "account id to sync" } ] }, "docs": "Syncs the account ARR and its orders to Salesforce." }, { "info": { "name": "Sync subscription to Salesforce", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/sfdc/sync/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Syncs the specified subscription to Salesforce." }, { "info": { "name": "Add a TaxJar integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/taxjar", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the integration ID if successful" }, { "info": { "name": "Test an integration is valid", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/taxjar/test", "body": { "type": "json", "data": "{}" } }, "docs": "Test an integration is valid" }, { "info": { "name": "Validate an address with TaxJar", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/taxjar/validate", "body": { "type": "json", "data": "{}" } }, "docs": "Returns a suggested addresses if found" }, { "info": { "name": "Get integration details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxjar/:integrationId", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "integration id" } ] }, "docs": "Gets the integration details of the specified integration id" } ] }, { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "revoke all keys", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/apikey/revoke" }, "docs": "Revokes all keys for your tenant" }, { "info": { "name": "Retrieve an API key by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/apikey/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve an api key referenced by its id" }, { "info": { "name": "Retrieves all API keys", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/apikey" }, "docs": "Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)" }, { "info": { "name": "Create a new api key", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/apikey", "params": [ { "name": "role", "value": "", "type": "query", "description": "Role-based permissions to be associated with the key. Specify this OR userId." }, { "name": "expiry", "value": "", "type": "query", "description": "Time of expiry in seconds since Epoch (GMT)" }, { "name": "userId", "value": "", "type": "query", "description": "User to associate key with. Specify this OR role." }, { "name": "entityId", "value": "", "type": "query", "description": "Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *)." } ] }, "docs": "Create a new api key with the specified parameters. The new key is returned" }, { "info": { "name": "revoke an API key by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/apikey/revoke/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Revoke an api key referenced by its id" }, { "info": { "name": "Get SAML Integration Status", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/auth/saml" }, "docs": "Retrieves SAML integration status" }, { "info": { "name": "Add a saml integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/auth/saml", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a saml integration" }, { "info": { "name": "Delete SAML Integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/auth/saml" }, "docs": "Deletes existing SAML integration" } ] }, { "info": { "name": "Approvals", "type": "folder" }, "items": [ { "info": { "name": "Get approval flows", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalFlows" }, "docs": "Gets all approval flows" }, { "info": { "name": "Add an approval flow", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/approvalFlows", "body": { "type": "json", "data": "{}" } }, "docs": "Adds an approval flow to the order execution hierarchy and returns its ID" }, { "info": { "name": "Get Details of an approval flow", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalFlows/:approvalFlowId", "params": [ { "name": "approvalFlowId", "value": "", "type": "path", "description": "id of the approval flow" } ] }, "docs": "Returns the details of the specified approval flow" }, { "info": { "name": "Update an approval flow", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/approvalFlows/:approvalFlowId", "params": [ { "name": "approvalFlowId", "value": "", "type": "path", "description": "id of the approval flow" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified approval flow" }, { "info": { "name": "Delete an approval flow", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/approvalFlows/:approvalFlowId", "params": [ { "name": "approvalFlowId", "value": "", "type": "path" } ] }, "docs": "Deletes an approval flow" }, { "info": { "name": "Get approval matrix details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalMatrix/csv" }, "docs": "Returns details regarding the approval matrices that have been uploaded" }, { "info": { "name": "Upload an Approval Matrix", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/approvalMatrix/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Upload a csv containing the order approval matrix to be used on order execution. The csv should have the following format: \nSegment, ApprovalRoleName1, ApprovalRoleName2 ...\nSegmentName1, UserEmailOrGroupName1, UserEmailOrGroupName2 ...\nRoles, userEmails, userGroups are expected to be added before putting them in this csv. Any new segment names defined here will add a new segment. If a segment isn't added, it shall be deleted." }, { "info": { "name": "Download approval matrix", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalMatrix/csv/download" }, "docs": "Downloads your order approval matrix as a csv" }, { "info": { "name": "Get import details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalMatrix/csv/:importId", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Gets the details of an import specified by the passed ID" }, { "info": { "name": "Download the csv for an import", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalMatrix/csv/:importId/download", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Downloads the CSV for an import activity specified by the passed ID" }, { "info": { "name": "Preview import changes", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalMatrix/csv/:importId/preview", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Preview the changes that a specified approval matrix import will have once applied" }, { "info": { "name": "Finalize an import", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/approvalMatrix/csv/:importId/submit", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Submit and finalize the import for the specified import operation." }, { "info": { "name": "Get approval roles", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalRoles" }, "docs": "Gets all approval roles" }, { "info": { "name": "Add an approval role", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/approvalRoles", "body": { "type": "json", "data": "{}" } }, "docs": "Adds an approval role to the order execution hierarchy and returns its ID" }, { "info": { "name": "Get Details of an approval role", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalRoles/:approvalRoleId", "params": [ { "name": "approvalRoleId", "value": "", "type": "path", "description": "id of the approval role" } ] }, "docs": "Returns the details of the specified approval role" }, { "info": { "name": "Update an approval role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/approvalRoles/:approvalRoleId", "params": [ { "name": "approvalRoleId", "value": "", "type": "path", "description": "id of the role" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified approval role" }, { "info": { "name": "Delete an approval role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/approvalRoles/:approvalRoleId", "params": [ { "name": "approvalRoleId", "value": "", "type": "path" } ] }, "docs": "Deletes an approval role" }, { "info": { "name": "Get approval segments", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalSegments" }, "docs": "Get all approval segments" }, { "info": { "name": "Add an approval segment", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/approvalSegments", "body": { "type": "json", "data": "{}" } }, "docs": "Define and add an approval segment which can be later specified in an approval matrix. The ID of the segment is returned." }, { "info": { "name": "Get approval segment details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/approvalSegments/:approvalSegmentId", "params": [ { "name": "approvalSegmentId", "value": "", "type": "path", "description": "id of the segment" } ] }, "docs": "Gets the details of the specified approval segment" }, { "info": { "name": "Update an approval segment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/approvalSegments/:approvalSegmentId", "params": [ { "name": "approvalSegmentId", "value": "", "type": "path", "description": "id of the segment" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of the specified approval segment" }, { "info": { "name": "Delete a segment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/approvalSegments/:approvalSegmentId", "params": [ { "name": "approvalSegmentId", "value": "", "type": "path", "description": "id of the segment" } ] }, "docs": "Deletes the segment specified by the id" }, { "info": { "name": "Get complete approval history for an order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:orderId/approvalHistory", "params": [ { "name": "orderId", "value": "ORD-9FB8TW8", "type": "path", "description": "ID of the order to retrieve approval history for" } ] }, "docs": "Returns comprehensive approval workflow history including all submission attempts and approver activity. \n\n**Important:** This endpoint returns ONLY approval domain data with user IDs and comment IDs as references. To get full details:\n- User details: Call GET /users with user IDs from this response\n- Order details: Call GET /orders/{orderId}\n- Comment messages: Call GET /orders/{orderId}/comments\n\nThe response includes:\n- All submission attempts (if order was rejected and resubmitted)\n- All wor" } ] }, { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Get the maximum number of attachments allowed for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/attachments/account/maxNumberOfFiles" }, "docs": "Gets the maximum number of files allowed to be attached to any account" }, { "info": { "name": "Get attachment contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/attachments/:attachmentId", "params": [ { "name": "attachmentId", "value": "", "type": "path", "description": "id of the attachment" } ] }, "docs": "Gets the contents of the specified attachment" }, { "info": { "name": "Delete an attachment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/attachments/:attachmentId", "params": [ { "name": "attachmentId", "value": "", "type": "path", "description": "id of the attachment" } ] }, "docs": "Unattaches and deletes the specified document" }, { "info": { "name": "Get attachments for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/attachments/account/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "id of the attachment" } ] }, "docs": "Lists all the documents attached to an account" }, { "info": { "name": "Add an attachment", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/attachments/account/:accountId", "params": [ { "name": "fileName", "value": "", "type": "query", "description": "name to associate with the attachment" }, { "name": "description", "value": "", "type": "query", "description": "description of the document" }, { "name": "accountId", "value": "", "type": "path", "description": "id of the account to attach the document to" }, { "name": "tag", "value": "", "type": "query", "description": "tag to apply to the attachment" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment is returned." }, { "info": { "name": "Update the details of an attachment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/attachments", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified document" } ] }, { "info": { "name": "Usage", "type": "folder" }, "items": [ { "info": { "name": "Match bank transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/bankTransactions/match", "body": { "type": "json", "data": "{}" } }, "docs": "Match bank transactions" }, { "info": { "name": "Add and apply bulk payments to invoices CSV", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settlements/addAndApplyPaymentsInBulk/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Bulk upload payments to invoices in CSV file" }, { "info": { "name": "Aggregate raw usage", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/v2/usage/aggregate" }, "docs": "Trigger the process to aggregate any remaining raw usage records" }, { "info": { "name": "Upload usage record CSV", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/v2/usage/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Upload usage records in CSV file. Each row of the file represents a single usage record" }, { "info": { "name": "Add usage record", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/v2/usage", "body": { "type": "json", "data": "{}" } }, "docs": "Load usage records into the system" }, { "info": { "name": "Get aggregated usage", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" } ] }, "docs": "Retrieve the current aggregated usage data for a subscription between 2 instants" }, { "info": { "name": "Get prepaid drawdown usage stats for subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/stats/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "ID of subscription to retrieve usages stats for" } ] }, "docs": "Retrieve the current prepaid drawdown statistics for a subscription" }, { "info": { "name": "Get prepaid drawdown usage stats CSV", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/stats/:subscriptionId/csv", "params": [ { "name": "subscriptionId", "value": "", "type": "path" } ] }, "docs": "Retrieve the current prepaid drawdown statistics for a subscription in CSV format" }, { "info": { "name": "Get prepaid drawdown usage stats PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/stats/:subscriptionId/pdf", "params": [ { "name": "subscriptionId", "value": "", "type": "path" } ] }, "docs": "Retrieve the current prepaid drawdown statistics for a subscription in PDF format" }, { "info": { "name": "Get all prepaid drawdown usage stats CSV", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/stats/csv", "params": [ { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" } ] }, "docs": "Retrieve the current prepaid drawdown statistics for all subscriptions for a time range in CSV format" }, { "info": { "name": "Get usage arrival checkpoint", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/v2/usage/aggregate/usageArrivalTimeCheckpoint" }, "docs": "Retrieve the latest usage record upload to the system as epoch seconds" } ] }, { "info": { "name": "BankTransactions", "type": "folder" }, "items": [ { "info": { "name": "Get paginated bank transaction records", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/bankTransactions/potentialInvoices", "params": [ { "name": "limit", "value": "", "type": "query", "description": "number of items per page" }, { "name": "pageToken", "value": "", "type": "query", "description": "pass this to subsequent calls" }, { "name": "bankAccountId", "value": "", "type": "query", "description": "optionally pass in bank account Id, only bank transactions for this bank account will be returned" } ] }, "docs": "Returns all bank transaction records in a paginated fashion" }, { "info": { "name": "Delete given bank transaction record", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/bankTransactions/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete given bank transaction record" }, { "info": { "name": "Import bank transactions via CSV", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/bankTransactions/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" }, { "name": "entityId", "type": "text", "value": "" } ] } }, "docs": "Import bank transactions via CSV" } ] }, { "info": { "name": "Product Catalog", "type": "folder" }, "items": [ { "info": { "name": "Get charge details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/charges/:chargeId", "params": [ { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ] }, "docs": "Gets the details of the specified charge." }, { "info": { "name": "Download revenue recognition fields", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/charges/revrec/csv/download" }, "docs": "Downloads your charge revenue recognition fields as a csv" }, { "info": { "name": "Backfill revenue recognition fields", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/charges/revrec/csv", "params": [ { "name": "isDryRun", "value": "", "type": "query" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Backfill API to update revenue recognition fields on charges" }, { "info": { "name": "Get ledger accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/plans/:planId/charges/:chargeId/ledgerAccounts", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" }, { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ] }, "docs": "Gets the ledger accounts mapped to the specified charge" }, { "info": { "name": "Map ledger accounts", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/charges/:chargeId/ledgerAccounts", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" }, { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Map ledger accounts to the specified charge for the specified plan." }, { "info": { "name": "Get replaced plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/plans/:planId/replacedPlans", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Get replaced plans" }, { "info": { "name": "Get plans", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/plans", "params": [ { "name": "productId", "value": "", "type": "query", "description": "id of the product" }, { "name": "status", "value": "", "type": "query", "description": "filter by plan status" }, { "name": "cursor", "value": "", "type": "query", "description": "cursor from the last call" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" } ] }, "docs": "Returns all plans for a product. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned." }, { "info": { "name": "Create a plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/plans", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a plan. On success the id of the new plan is returned." }, { "info": { "name": "Get plan details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Returns the details of the specified plan." }, { "info": { "name": "Update plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified plan. Note you can't update the details of a plan once it's in use." }, { "info": { "name": "Delete a plan", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/plans/:planId", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Deletes a plan. Note you can't delete a plan that's in use." }, { "info": { "name": "Update plan terms", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/terms", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates predefined terms associated with the specified plan." }, { "info": { "name": "Update plan metadata", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/metadata", "params": [ { "name": "planId", "value": "", "type": "path", "description": "plan id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update plan metadata. For now, this can be used only to change the entities assigned to a plan" }, { "info": { "name": "Revert a plan to draft", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/revertToDraft", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Marks a plan as draft" }, { "info": { "name": "Add charge to plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/plans/:planId/charges", "params": [ { "name": "planId", "value": "", "type": "path", "description": "ID of the plan to which you want to add the charge. To get a list of IDs, call the [Get plans](/reference/getplans) operation." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a charge to the specified plan. Success response contains ID of the new charge." }, { "info": { "name": "Update non-financial charge details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/charges/:chargeId/partial", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" }, { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates certain details of the specified charge which won't impact its financial treatment" }, { "info": { "name": "Activate a plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/activate", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Marks a plan as active" }, { "info": { "name": "Deprecate a plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/deprecate", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Marks a plan as deprecated. Once deprecated a plan may not be attached to new orders." }, { "info": { "name": "Reactivate a plan", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/reactivate", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" } ] }, "docs": "Reactivates a deprecated plan." }, { "info": { "name": "Duplicate a plan", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/plans/:planId/duplicate", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan to duplicate" } ] }, "docs": "Duplicates the specified plan. On success the new plan id is returned." }, { "info": { "name": "Update charge details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/plans/:planId/charges/:chargeId", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan associated with the charge" }, { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified charge on the specified plan." }, { "info": { "name": "Delete a charge", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/plans/:planId/charges/:chargeId", "params": [ { "name": "planId", "value": "", "type": "path", "description": "id of the plan" }, { "name": "chargeId", "value": "", "type": "path", "description": "id of the charge" } ] }, "docs": "Removes a charge from a plan." }, { "info": { "name": "Get Plans that have a specific value for a custom field", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/plans/filter/customField", "params": [ { "name": "customFieldName", "value": "", "type": "query", "description": "Name of the custom field to filter by" }, { "name": "customFieldValue", "value": "", "type": "query", "description": "Value of the custom field to filter by" } ] }, "docs": "Gets Plans that have a specific value for a custom field" }, { "info": { "name": "Get product category details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/product/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the category" } ] }, "docs": "Gets the details of the specified product category" }, { "info": { "name": "Update product category details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/product/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the category" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a product category" }, { "info": { "name": "Delete a product category", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/product/categories/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the category" } ] }, "docs": "Deletes the specified product category. Note that a product category can't be delete once it's in use." }, { "info": { "name": "Get product Categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/product/categories", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "cursor from prior call" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" } ] }, "docs": "Gets all product categories for your tenant. The results are paginated. To fetch all results pass the cursor returned from a call to the subsequent calls until all results are returned. Initially the cursor should not be specified." }, { "info": { "name": "Create a product category", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/product/categories", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a product category. On success the id of the category is returned." }, { "info": { "name": "Get product details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/products/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the product" } ] }, "docs": "Gets the details of the specified product." }, { "info": { "name": "Update product details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/products/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the product" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified product" }, { "info": { "name": "Delete a product", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/products/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the product" } ] }, "docs": "Delete the specified product." }, { "info": { "name": "Export product catalog", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/products/export" }, "docs": "Export the product catalog in CSV format." }, { "info": { "name": "Get products", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/products", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "cursor received from prior call" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" } ] }, "docs": "Returns all products for your tenant. The results on paginated. To fetch them all pass the cursor returned from a call to the subsequent call until all results are fetched. Initially the cursor should not be specified." }, { "info": { "name": "Create a product", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/products", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a product for your tenant. The success response contains the ID of the product." } ] }, { "info": { "name": "Orders", "type": "folder" }, "items": [ { "info": { "name": "Update composite order status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/compositeOrders/:id/status/:status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the composite order." }, { "name": "status", "value": "", "type": "path", "description": "New status to be set for the composite order: Draft, Submitted or Executed" }, { "name": "statusUpdatedOn", "value": "", "type": "query", "description": "The timestamp when composite order status was updated." }, { "name": "adminApprovalFlowByPass", "value": "", "type": "query", "description": "Admin approval to bypass the approval flow" } ] }, "docs": "Update the status of a specific composite order by its ID." }, { "info": { "name": "Fetch composite order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/compositeOrders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the composite order" } ] }, "docs": "Fetches the composite order with the specified id." }, { "info": { "name": "Delete composite order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/compositeOrders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the composite order" } ] }, "docs": "Deletes the composite order with the specified id." }, { "info": { "name": "Mark composite order as executed.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/compositeOrders/:id/execute", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the composite order." }, { "name": "executedOn", "value": "", "type": "query", "description": "The date and time when the composite order was executed." }, { "name": "adminApprovalFlowBypass", "value": "", "type": "query", "description": "Bypass approval checks by admin" } ] }, "docs": "Marks the composite order as executed. This also executes the individual orders contained. Optionally, the execution time can be specified using the executedOn query parameter." }, { "info": { "name": "Fetch composite order form PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/compositeOrders/:id/pdf", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the order" } ] }, "docs": "Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document." }, { "info": { "name": "Generate a composite order PDF", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/compositeOrders/:id/pdf", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the composite order" } ] }, "docs": "Generates a composite order form PDF. When completed this document can be downloaded via a get to /{id}/pdf." }, { "info": { "name": "Return all opportunities", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/opportunity", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "pass the cursor returned from a call to to subsequent calls until all values are fetched" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" }, { "name": "accountId", "value": "", "type": "query", "description": "id of account" }, { "name": "crmId", "value": "", "type": "query", "description": "CRM ID of the opportunity" } ] }, "docs": "Returns all opportunities associated with the specified account. The results are paginated. To fetch all results, pass the cursor returned from a call to subsequent calls." }, { "info": { "name": "Return details of an opportunity", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/opportunity/crm/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "crm id of the opportunity" } ] }, "docs": "Returns the details of a specified opportunity" }, { "info": { "name": "Delete an opportunity with given CRM ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/opportunity/crm/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "crm id of the opportunity" } ] }, "docs": "Delete an opportunity with given CRM ID if there are no associated orders" }, { "info": { "name": "Return details of an opportunity", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/opportunity/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the opportunity" } ] }, "docs": "Returns the details of a specified opportunity" }, { "info": { "name": "Return a list of orders associated with a CRM opportunity id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/opportunity/crm/:id/orders", "params": [ { "name": "id", "value": "", "type": "path", "description": "crm id of the opportunity" } ] }, "docs": "Returns the details of orders" }, { "info": { "name": "Get order details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "suppressIdFormValidation", "value": "", "type": "query", "description": "if set to true then the if form will not be validated" } ] }, "docs": "Retrieve details of a specific order by its ID." }, { "info": { "name": "Delete an order", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/orders/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the order to be deleted." } ] }, "docs": "Delete a specific order by its ID." }, { "info": { "name": "Get all Orders", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "A string token is used to fetch next set of results. If not provided, the first page of results will be returned. Use the 'next_cursor' value from the previous response to fetch the next page." }, { "name": "limit", "value": "", "type": "query", "description": "An integer specifying the maximum number of results to return per page. Defaults to 10 if not provided. Limit is capped to 50 orders" } ] }, "docs": "Gets all orders for your tenant. The results are paginated. To fetch all results, take the cursor returned from a call and pass it to subsequent calls." }, { "info": { "name": "Create an order", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/orders", "params": [ { "name": "isDryRun", "value": "", "type": "query", "description": "indicates whether this order should be persisted." }, { "name": "populateMissingLines", "value": "", "type": "query", "description": "indicates whether an amendment should populate missing lines not provided here." } ], "body": { "type": "json", "data": "{}" } }, "docs": "creates an order with the specified parameters. On success the order id is returned." }, { "info": { "name": "Update order details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders", "params": [ { "name": "isDryRun", "value": "", "type": "query", "description": "true if the order should not be persisted." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified order." }, { "info": { "name": "Update order status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders/:id/status/:status", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "status", "value": "", "type": "path", "description": "New status to be set for the order (e.g: Draft, Submitted, Executed, Cancelled)" }, { "name": "statusUpdatedOn", "value": "", "type": "query", "description": "The timestamp when order status was updated." }, { "name": "adminApprovalFlowByPass", "value": "", "type": "query", "description": "Admin approval to bypass the approval flow" } ] }, "docs": "Update the status of a specific order by its ID." }, { "info": { "name": "Get order metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "targetDate", "value": "", "type": "query", "description": "The target date for filtering metrics." } ] }, "docs": "Retrieve the metrics for a specific order by its ID. Metrics can be filtered by a target date." }, { "info": { "name": "Rebase amendment against latest subscription version", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders/:orderId/rebase", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Rebase a specific order by its ID. Rebasing an order involves recalculating its metrics or values based on updated data or criteria." }, { "info": { "name": "Update order attributes for non-draft orders", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders/:orderId/attributes", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update order attributes for non-draft orders" }, { "info": { "name": "Fetch order form PDF", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id/pdf", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Retrieves the PDF version of the order form for a specific order identified by its ID." }, { "info": { "name": "Generate an order PDF", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/orders/:id/pdf", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "force", "value": "", "type": "query", "description": "Force regeneration of the PDF document even if there has been no changes. Defaults to false." } ] }, "docs": "Generate and retrieve a PDF representation of the order details for a specific order by its ID." }, { "info": { "name": "Fetch specific order form PDF on order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:orderId/pdf/:id", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Uniquely identifies the orderId" }, { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the pdf id." } ] }, "docs": "Retrieves specific PDF of the order form for a specific order identified by its orderId." }, { "info": { "name": "Download word doc version of order form", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id/doc", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Download a Microsoft Word document of the order form for a specific order by its ID." }, { "info": { "name": "Download word docx version of order form", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id/docx", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Download a Microsoft Word document of the order form for a specific order by its ID." }, { "info": { "name": "Mark order as executed.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders/:id/execute", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "executedOn", "value": "", "type": "query", "description": "The date and time when the order was executed." }, { "name": "adminApprovalFlowBypass", "value": "", "type": "query", "description": "Bypass approval flows by admin" } ] }, "docs": "Marks the order as executed. Optionally, the execution time can be specified using the executedOn query parameter." }, { "info": { "name": "Mark order as executed", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/orders/:id/execute/force", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." }, { "name": "executedOn", "value": "", "type": "query", "description": "The date and time when the order was executed." }, { "name": "skipApprovalCheck", "value": "", "type": "query", "description": "Indicates whether to skip the approval check. Default is false." } ] }, "docs": "Forcefully executes an order. This endpoint bypasses approval checks and immediately executes the order." }, { "info": { "name": "Get order line metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:id/lineItems/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Retrieves metrics for all line items associated with the specified order." }, { "info": { "name": "Get custom billing schedule for the order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/orders/:orderId/billing/custom", "params": [ { "name": "orderId", "value": "", "type": "path", "description": "Uniquely identifies the Order." } ] }, "docs": "Get the custom billing schedule for the order" } ] }, { "info": { "name": "Credit Memo", "type": "folder" }, "items": [ { "info": { "name": "Mark Credit Memo as voided", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber/void", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Marks the specified Credit Memo as voided" }, { "info": { "name": "Get credit memos for an account", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/creditmemos", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "id of the account" }, { "name": "cursor", "value": "", "type": "query", "description": "cursor used to move the pages" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" } ] }, "docs": "Returns a paginated list of credit memos for the specified account. Pass the cursor returned to subsequent calls to retrieve all data." }, { "info": { "name": "Create a standalone credit memo", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/creditmemos", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a standalone credit memo for a specified account. On success the number of the new memo is returned" }, { "info": { "name": "Get credit memo details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Returns the details of the specified credit memo" }, { "info": { "name": "Update a credit memo", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "credit memo number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of a credit memo in DRAFT status" }, { "info": { "name": "Delete a credit memo", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Deletes the specified credit memo. The credit memo must be in DRAFT status" }, { "info": { "name": "Post a credit memo", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber/post", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Sets the status of the specified credit memo to POSTED" }, { "info": { "name": "Download credit memo pdf", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber/pdf", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Downloads the pdf version of the credit memo. Note the credit memo must already have been created. If the credit memo is still in the process of being created, HTTP 202 is returned." }, { "info": { "name": "Create a credit memo document", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber/pdf", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Creates a pdf version of the credit memo" }, { "info": { "name": "Get credit memo configuration for the tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/creditmemos/configuration" }, "docs": "Returns the credit memo configuration for your tenant" }, { "info": { "name": "Update credit memo configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/creditmemos/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the credit memo configuration for you tenant." }, { "info": { "name": "Convert invoice to credit memo", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/creditmemos/convert/:invoiceNumber", "params": [ { "name": "invoiceNumber", "value": "", "type": "path", "description": "number of the invoice" } ] }, "docs": "Converts the specified invoice to a credit memo. Note the invoice must be in DRAFT status and have a negative balance." }, { "info": { "name": "Get credit memo balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/creditmemos/:creditMemoNumber/balance", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path", "description": "number of the credit memo" } ] }, "docs": "Gets the balance of the specified credit memo" } ] }, { "info": { "name": "CRM field mapping", "type": "folder" }, "items": [ { "info": { "name": "Get CRM field mapping upload list", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crmFieldMapping/csv" }, "docs": "Returns details regarding the CRM field mappings that have been uploaded" }, { "info": { "name": "Upload of CRM field mappings", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/crmFieldMapping/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": " crmType: HUBSPOT, SALESFORCE\n crmObjectType: OPPORTUNITY, ACCOUNT, ORDER\n direction: INBOUND, OUTBOUND\n crmFieldName\n subskribeFieldName\n" }, { "info": { "name": "Get import details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crmFieldMapping/csv/:importId", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Gets the details of an import specified by the passed ID" }, { "info": { "name": "Download the csv for an import", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crmFieldMapping/csv/:importId/download", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Downloads the CSV for an import activity specified by the passed ID" }, { "info": { "name": "Preview import changes", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crmFieldMapping/csv/:importId/preview", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Preview the changes that a CRM field mapping import will have once applied" }, { "info": { "name": "Download CRM field mappings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/crmFieldMapping/csv/download" }, "docs": "Downloads your CRM field mappings as a csv" }, { "info": { "name": "Finalize an import", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/crmFieldMapping/csv/:importId/submit", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Submit and finalize the import for the specified import operation." } ] }, { "info": { "name": "Custom Field", "type": "folder" }, "items": [ { "info": { "name": "Create a custom field definition", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/customFieldDefinition", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned." }, { "info": { "name": "Get custom field definitions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/customFieldDefinition/:parentObjectType", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "object type custom fields are attached to" } ] }, "docs": "Returns all custom field definitions for a specific parent object type" }, { "info": { "name": "Update an existing custom field definition", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customFieldDefinition/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing custom field definition for your tenant. On success the update custom field definition is returned." }, { "info": { "name": "Delete a custom field definition", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/customFieldDefinition/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "object type custom fields are attached to" } ] }, "docs": "Deletes an existing custom field definition for your tenant. On success the deleted custom field definition object is returned." }, { "info": { "name": "Update an existing set of custom fields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customField/:parentObjectType/:parentObjectId/:customFieldName", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "Object type custom fields are attached to. Available Object Types: ACCOUNT, ORDER, ORDER_ITEM, PLAN, CHARGE, INVOICE, SUBSCRIPTION_ITEM,OPPORTUNITY" }, { "name": "parentObjectId", "value": "", "type": "path", "description": "Id of the parent object" }, { "name": "customFieldName", "value": "", "type": "path", "description": "Name of the custom field to be updated" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned." }, { "info": { "name": "Get custom fields by type and parent object id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/customField/:parentObjectType/:parentObjectId", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "object type custom fields are attached to" }, { "name": "parentObjectId", "value": "", "type": "path", "description": "Id of the parent object" } ] }, "docs": "Returns all custom fields for a specific parent object type and id" }, { "info": { "name": "Update an existing set of custom fields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customField/:parentObjectType/:parentObjectId", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "object type custom fields are attached to. Available Object Types: ACCOUNT, ORDER, ORDER_ITEM, PLAN, CHARGE, INVOICE, SUBSCRIPTION_ITEM,OPPORTUNITY" }, { "name": "parentObjectId", "value": "", "type": "path", "description": "Id of the parent object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned." }, { "info": { "name": "Update an existing set of custom fields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customField/:parentObjectType/:parentObjectId/force", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "Object type custom fields are attached to. Available Object Types: ACCOUNT, ORDER, ORDER_ITEM, PLAN, CHARGE, INVOICE, SUBSCRIPTION_ITEM,OPPORTUNITY" }, { "name": "parentObjectId", "value": "", "type": "path", "description": "Id of the parent object" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned." }, { "info": { "name": "Update an existing set of custom fields", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customField/:parentObjectType/:parentObjectId/:customFieldName/force", "params": [ { "name": "parentObjectType", "value": "", "type": "path", "description": "Object type custom fields are attached to. Available Object Types: ACCOUNT, ORDER, ORDER_ITEM, PLAN, CHARGE, INVOICE, SUBSCRIPTION_ITEM,OPPORTUNITY" }, { "name": "parentObjectId", "value": "", "type": "path", "description": "Id of the parent object" }, { "name": "customFieldName", "value": "", "type": "path", "description": "Name of the custom field to be updated" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned." } ] }, { "info": { "name": "Customization", "type": "folder" }, "items": [ { "info": { "name": "Get the current selection customization defined", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/customization/selectionCustomization" }, "docs": "returns a .zeppa source file for the current selection customization if present, 404 if customization is not defined" }, { "info": { "name": "Add or Update selection customization script", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customization/selectionCustomization", "params": [ { "name": "testAccountId", "value": "", "type": "query", "description": "before the script is actually stored the script is run against this test account id, it *DOES NOT MEAN* this customization is only for this account" }, { "name": "expectedVersion", "value": "", "type": "query", "description": "this is the expected version of the script that is currently stored \n- if the expected version does not match what is stored the call will fail \n- if the script is being added for the first time then the expected version is 0 \n- look at the GET call for how the current version number is returned" } ] }, "docs": "Add or Update the selection customization zeppa script in the platform. \n - once the update happens new selection customization script will take effect \n - the updated version of the script is returned with the API call \nNOTE: the account id required for this is only for test before submission \nNOTE: it *does not mean* that this customization is run only for this account.\n" }, { "info": { "name": "Get the current order creation customization defined", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/customization/orderCreationCustomization" }, "docs": "returns a .zeppa source file for the current order creation customization if present, 404 if customization is not defined" }, { "info": { "name": "Add or Update order creation customization script", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/customization/orderCreationCustomization", "params": [ { "name": "testOrderId", "value": "", "type": "query", "description": "before the script is actually stored its run against this test order id. it *DOES NOT MEAN* this customization is only for this order" }, { "name": "expectedVersion", "value": "", "type": "query", "description": "this is the expected version of the script that is currently stored\n- if the expected version does not match what is stored the call will fail\n- if the script is being added for the first time then the expected version is 0\n- look at the GET call for how the current version number is returned" } ] }, "docs": "Add or Update the order creation customization zeppa script in the platform.\n - once the update happens new this script will take effect for all order creations\n - the updated version of the script is returned with the API call\nNOTE: the order id required for this is only for test before submission\nNOTE: it *does not mean* that this customization is run only for this order.\n" } ] }, { "info": { "name": "Deal Pulse", "type": "folder" }, "items": [ { "info": { "name": "Get all deal pulses for tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/deal-pulse" }, "docs": "Returns all deal pulses for the current tenant, sorted by pulse score (highest first) and last updated" }, { "info": { "name": "Get deal pulse for a specific sales room", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/deal-pulse/sales-rooms/:salesRoomId", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ] }, "docs": "Returns the calculated deal pulse score, category, AI recommendations, and engagement details for a sales room" }, { "info": { "name": "Track deal pulse event", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/deal-pulse/sales-rooms/:salesRoomId/events", "params": [ { "name": "salesRoomId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Records a deal pulse event and triggers pulse score recalculation" } ] }, { "info": { "name": "Discounts", "type": "folder" }, "items": [ { "info": { "name": "Get discounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/discounts" }, "docs": "Returns all discounts that have been defined" }, { "info": { "name": "Create a discount", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/discounts", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a discount with the specified details. On success, the ID of the new discount is returned." }, { "info": { "name": "Get discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/discounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the discount" } ] }, "docs": "Returns the details of the specified discount." }, { "info": { "name": "Update discount details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/discounts/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the discount" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified discount. Note that a discount cannot be updated once it is in use by an order." }, { "info": { "name": "Delete a discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/discounts/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes a discount. Note that a discount may not be deleted if it is in use." }, { "info": { "name": "Update discount status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/discounts/:id/status/:status", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the discount" }, { "name": "status", "value": "", "type": "path", "description": "new status to set" } ] }, "docs": "Updates the status of a discount" } ] }, { "info": { "name": "Documents", "type": "folder" }, "items": [ { "info": { "name": "Get predefined terms", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/predefinedTerms", "params": [ { "name": "type", "value": "", "type": "query" } ] }, "docs": "Returns predefined terms by type. These templates can be attached to orders as part of PDF document generation." }, { "info": { "name": "Add new predefined terms", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/predefinedTerms", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new predefined terms that can be attached to an order as part of PDF document generation." }, { "info": { "name": "Get predefined terms versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/predefinedTerms/:id/versions", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns predefined terms versions by Id." }, { "info": { "name": "Get predefined terms detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/predefinedTerms/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns a specific predefined terms by Id." }, { "info": { "name": "Update predefined terms", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/predefinedTerms/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a predefined terms" }, { "info": { "name": "Delete predefined terms", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/predefinedTerms/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes the predefined terms specified." }, { "info": { "name": "Update predefined terms status", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/predefinedTerms/:id/status/:status", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the predefined terms" }, { "name": "status", "value": "", "type": "path", "description": "new status to set" } ] }, "docs": "Updates the status of a predefined terms" }, { "info": { "name": "Get predefined terms version detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/predefinedTerms/:id/versions/:version", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "path" } ] }, "docs": "Returns a specific predefined terms by Id and version." } ] }, { "info": { "name": "Email", "type": "folder" }, "items": [ { "info": { "name": "Fetch the email settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/emailSettings" }, "docs": "Returns a list of email settings" }, { "info": { "name": "Add a new email setting", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/emailSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new email setting" }, { "info": { "name": "Update an existing email setting", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/emailSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing email setting" }, { "info": { "name": "Delete an email setting", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/emailSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Delete an email setting" } ] }, { "info": { "name": "Entities", "type": "folder" }, "items": [ { "info": { "name": "Gets entities", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/entities" }, "docs": "Gets all entities" }, { "info": { "name": "Create an entity", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/entities", "body": { "type": "json", "data": "{}" } }, "docs": "Create an entity. On success return the created entity." }, { "info": { "name": "Gets entity details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/entities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity id" } ] }, "docs": "Gets the entity details of the specified entity id" }, { "info": { "name": "Delete entity", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/entities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "entity id" } ] }, "docs": "Delete the entity if there is no data associated with it." }, { "info": { "name": "Get entity logo", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/entities/logo/:entityId", "params": [ { "name": "entityId", "value": "", "type": "path" } ] }, "docs": "Get the current logo stored for the given entity" }, { "info": { "name": "Update entity logo", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/entities/logo/:entityId", "params": [ { "name": "entityId", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Updates the logo used in external facing communication such as order forms and invoices" } ] }, { "info": { "name": "ERP", "type": "folder" }, "items": [ { "info": { "name": "Trigger ERP journal entry sync task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/processSyncTasks/:accountingPeriodId", "params": [ { "name": "accountingPeriodId", "value": "", "type": "path" } ] }, "docs": "Trigger ERP journal entry sync task for given accounting period id" }, { "info": { "name": "Trigger ERP journal entry deletion task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/processDeleteTasks/:accountingPeriodId", "params": [ { "name": "accountingPeriodId", "value": "", "type": "path" } ] }, "docs": "Trigger ERP journal entry deletion task for the given accounting period id" }, { "info": { "name": "Trigger ERP invoice sync task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/syncInvoice/:invoiceId", "params": [ { "name": "invoiceId", "value": "", "type": "path" } ] }, "docs": "Trigger ERP invoice sync task for the given invoice id" }, { "info": { "name": "Check if invoice sync to ERP is enabled", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/erp/syncInvoice/enabled" }, "docs": "Checks if invoice sync to ERP is enabled" }, { "info": { "name": "Trigger ERP invoice sync tasks for multiple invoices", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/syncInvoices", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger ERP invoice sync tasks for the given list of invoice IDs" }, { "info": { "name": "Trigger ERP credit memo sync task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/syncCreditMemo/:creditMemoNumber", "params": [ { "name": "creditMemoNumber", "value": "", "type": "path" } ] }, "docs": "Trigger ERP credit memo sync task for the given credit memo number" }, { "info": { "name": "Trigger ERP void invoice sync task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/erp/syncVoidInvoice/:invoiceNumber", "params": [ { "name": "invoiceNumber", "value": "", "type": "path" } ] }, "docs": "Trigger ERP void invoice sync task for the given invoice number" }, { "info": { "name": "getInvoiceErpSyncData", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/invoices/:invoiceId/erpSync", "params": [ { "name": "invoiceId", "value": "", "type": "path", "description": "Invoice number." } ] } }, { "info": { "name": "getPaymentErpSyncData", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/payments/:paymentId/erpSync", "params": [ { "name": "paymentId", "value": "", "type": "path", "description": "Payment id." } ] } } ] }, { "info": { "name": "Experimental", "type": "folder" }, "items": [ { "info": { "name": "getUsecaseScript", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:id/qscript", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "putQScript", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:id/qscript", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "listUsecases", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/guidedSelling/usecase" } }, { "info": { "name": "addUsecase", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/guidedSelling/usecase", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Get Next Question for Guided Selling", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:usecase/nextQuestion", "params": [ { "name": "usecase", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the next question given a set of answers to questions so far" }, { "info": { "name": "Get The next set of questions based on the answers provided so far", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:usecase/nextQuestions", "params": [ { "name": "usecase", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the ordered list of all relevant questions to answer based on the answers provided so far" }, { "info": { "name": "getUsecase", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateUsecase", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "deleteUsecase", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Build an order using the guided selling answers", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/usecase/:usecase/buildOrder", "params": [ { "name": "usecase", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "query" }, { "name": "saveOrder", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "For a given use case this API allows building the order, given account id. you can also save the order" }, { "info": { "name": "Use AI to get answers for guided selling questions", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/guidedSelling/ai/answers", "body": { "type": "json", "data": "{}" } }, "docs": "Get the answer to guided selling questions form the deal desk AI, when all questions are answered then return the Answers for the guided selling" } ] }, { "info": { "name": "Import", "type": "folder" }, "items": [ { "info": { "name": "Get import details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/:importId/result", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Returns the details of an import by its ID" }, { "info": { "name": "Gets all import items", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import" }, "docs": "Gets all items that was imported" }, { "info": { "name": "Validate import file", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/import", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Validates a multi-part import file. Returns an import ID on success." }, { "info": { "name": "Gets an import item", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/:importId", "params": [ { "name": "importId", "value": "", "type": "path", "description": "id of the item" } ] }, "docs": "Gets an item that was imported by its ID" }, { "info": { "name": "Get new orders in import CSV format", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/export/newOrders", "params": [ { "name": "useRealIds", "value": "", "type": "query", "description": "use the subskribe ID instead of external ID for exported objects" } ] }, "docs": "Gets new orders in a format appropriate for re-import. On success, the output is a csv containing the orders." }, { "info": { "name": "Get amendment orders in import CSV format", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/export/amendmentOrders", "params": [ { "name": "generation", "value": "", "type": "query", "description": "the generation of amendments to include in the export, generations are defined as 1 based index of number of amendments applied to subscription" }, { "name": "useRealIds", "value": "", "type": "query", "description": "use the subskribe ID instead of external ID for exported objects" } ] }, "docs": "Gets amendment orders in a format appropriate for re-import for the given generation. On success, the output is a csv containing the orders." }, { "info": { "name": "Get account contacts for export", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/export/accountContact" }, "docs": "Gets account contacts in a format appropriate for re-import. On success, the output is a csv containing the account and contacts." }, { "info": { "name": "Get catalog data for export", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/export/catalog" }, "docs": "Gets catalog data in a format appropriate for re-import. On success, the output is a csv containing the catalog data containing Product, Plan and Charge data." }, { "info": { "name": "Process an import by ID", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/import/:importId/process", "params": [ { "name": "importId", "value": "", "type": "path" } ] }, "docs": "Processes the import specified." }, { "info": { "name": "Return available schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/import/schemas" }, "docs": "Returns the set of schemas available for import" }, { "info": { "name": "Create a Flatfile workbook", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/import/flatfile/:domain", "params": [ { "name": "domain", "value": "", "type": "path", "description": "the domain to import" } ] }, "docs": "Creates a Flatfile workbook and adds it to a space" } ] }, { "info": { "name": "MetricsReporting", "type": "folder" }, "items": [ { "info": { "name": "gets external arr metrics request for the provided id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/metricsReporting/externalArrMetrics/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the externalArrMetrics request" } ] }, "docs": "returns the external arr metrics request for the provided id" }, { "info": { "name": "gets external arr metrics requests submitted", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/metricsReporting/externalArrMetrics", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "returns the paginated list of external arr metrics requests" }, { "info": { "name": "submit request to generate external arr metrics", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/metricsReporting/externalArrMetrics", "body": { "type": "json", "data": "{}" } }, "docs": "returns the request with its captured id. Arr metrics will be generated as a backend job" }, { "info": { "name": "submit request to generate/regenerate arr metrics for a subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/metricsReporting/populateArrMetrics/subscriptions/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "id of the subscription" } ] }, "docs": "returns 200 if the result is successfully submitted to a background task" } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "Get all notifications", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/notifications" }, "docs": "Returns all notification subscriptions for your tenant" }, { "info": { "name": "Add a notification target", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/notifications", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a notification target and events according to the specified parameters" }, { "info": { "name": "Attach an event to a notification", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/notifications/:notificationId", "params": [ { "name": "notificationId", "value": "", "type": "path", "description": "id of the notification target" }, { "name": "notificationEventType", "value": "", "type": "query", "description": "type of event" } ] }, "docs": "Attaches a notification event to the target specified by the notification id" }, { "info": { "name": "Unsubscribe from an event", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/notifications/unsubscribe/:notificationId", "params": [ { "name": "notificationId", "value": "", "type": "path", "description": "id of the notification target" }, { "name": "notificationEventType", "value": "", "type": "query", "description": "type of event" } ] }, "docs": "Unsubscribes the specified notification target from the specified event" } ] }, { "info": { "name": "Opportunity", "type": "folder" }, "items": [ { "info": { "name": "Creates a standalone opportunity", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/opportunity", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the details of a specified opportunity" }, { "info": { "name": "Updates a standalone opportunity", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/opportunity/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the opportunity" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the details of the updated opportunity" }, { "info": { "name": "Opens an opportunity", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/opportunity/:id/open", "params": [ { "name": "id", "value": "", "type": "path", "description": "crm id or native id of the opportunity" } ] }, "docs": "Returns the details of the updated opportunity" }, { "info": { "name": "Get opportunities by account CRM ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/opportunity/accountCrmId/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Account CRM ID" } ] }, "docs": "Returns the opportunities for an account with a specific CRM ID" } ] }, { "info": { "name": "Payments", "type": "folder" }, "items": [ { "info": { "name": "Get a payment bank account by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/bank-account/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Payment bank account id" } ] }, "docs": "Get a payment bank account by id" }, { "info": { "name": "Get a payment bank account by id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/payments/bank-account/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Payment bank account id" } ] }, "docs": "Get a payment bank account by id" }, { "info": { "name": "Manually retries a payment", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/payments/:paymentId/retry/manual", "params": [ { "name": "paymentId", "value": "", "type": "path", "description": "Payment id" }, { "name": "lastPaymentAttemptId", "value": "", "type": "query", "description": "Last payment attempt id" } ] }, "docs": "Manually retries a payment based on the provided payment ID and last attempt ID" }, { "info": { "name": "Gets the list of payment integrations", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/payment-gateways" }, "docs": "Gets the list of all active and completed payment integrations for the tenant" }, { "info": { "name": "Gets cash and expense ledger accounts for bank account creation", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/bank-account/accounts/ledger", "params": [ { "name": "id", "value": "", "type": "query" } ] }, "docs": "The bank account would be mapped to a cash and an expense ledger account from this list" }, { "info": { "name": "Processes one time payment for an invoice if there is an automatic payment set up for the account", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/payments/processPaymentForInvoice/:invoiceNumber", "params": [ { "name": "invoiceNumber", "value": "", "type": "path" } ] }, "docs": "The automatic payment is processed via Stripe for this invoice" }, { "info": { "name": "Gets a payment retry configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/retry/config", "params": [ { "name": "groupingId", "value": "", "type": "query", "description": "groupingId of the payment retry configuration" } ] }, "docs": "Gets the latest payment retry configuration for the tenant, or by the grouping id if specified" }, { "info": { "name": "Creates or updates a payment retry configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/payments/retry/config", "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates a payment retry configuration for the tenant" }, { "info": { "name": "Deletes a payment retry configuration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/payments/retry/config/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the payment retry configuration to be deleted" } ] }, "docs": "Deletes a payment retry configuration for the tenant" }, { "info": { "name": "Get payment details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the payment" } ] }, "docs": "Gets the details of the specified payment" }, { "info": { "name": "Delete payment by payment id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/payments/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Payment bank account id" } ] }, "docs": "Deletes the specified payment if the payment has been voided. This operation also deletes any applications of this payment" }, { "info": { "name": "Get payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/account/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the account" } ] }, "docs": "Returns the payments for the specified account" }, { "info": { "name": "Get payment configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/configuration" }, "docs": "Returns the payment configuration for your tenant" }, { "info": { "name": "Update payment configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/payments/configuration", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the payment configuration for your tenant." }, { "info": { "name": "Get account payment management link", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/account-payment/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns a payment management link for an account" }, { "info": { "name": "Adds a new payment bank account", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/payments/bank-account", "body": { "type": "json", "data": "{}" } }, "docs": "The bank account would be mapped to a cash and an expense ledger account" }, { "info": { "name": "Get all payments", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "cursor returned from previous call" }, { "name": "limit", "value": "", "type": "query", "description": "number of results per page" } ] }, "docs": "Returns all payments for you tenant. The results are paginated. To fetch all take the cursor returned from a call and pass it to a subsequent call." }, { "info": { "name": "Check if the payment object can be deleted", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/:id/canDelete", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the payment" } ] }, "docs": "Payment can be deleted if it has been voided and does not have journal entries associated" }, { "info": { "name": "Get payment balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/payments/:id/balance", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the payment" } ] }, "docs": "Gets the balance of a payment" }, { "info": { "name": "Voids a payment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/payments/:id/void", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Voids the specified payment per the specified parameters" }, { "info": { "name": "Import Stripe payment method via CSV", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/stripe-import/payment-method/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Associate an existing Stripe payment method with an account" } ] }, { "info": { "name": "Health", "type": "folder" }, "items": [ { "info": { "name": "Simple ping with auth to check if everything is working fine", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ping" }, "docs": "Call this resource to make sure API auth is setup correctly, a simple PONG message is returned and the assumption is that auth succeed" } ] }, { "info": { "name": "Platform Feature", "type": "folder" }, "items": [ { "info": { "name": "Check if the tenant has accounting feature enabled", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/platformFeature/isAccountingFeatureEnabled" }, "docs": "Returns whether the tenant has accounting feature enabled." } ] }, { "info": { "name": "Settings", "type": "folder" }, "items": [ { "info": { "name": "Get predefined terms section detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/termsections/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns predefined terms section detail." }, { "info": { "name": "Update predefined terms section", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/termsections/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the predefined terms section specified." }, { "info": { "name": "Delete predefined terms section", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/termsections/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes the predefined terms section specified." }, { "info": { "name": "Get predefined terms sections", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/termsections" }, "docs": "Returns predefined terms sections." }, { "info": { "name": "Add predefined terms section", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/termsections", "body": { "type": "json", "data": "{}" } }, "docs": "Adds a predefined terms section." }, { "info": { "name": "Get tax rate strategy by Id and Country Code", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxrates/strategies/:id/:countryCode", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "countryCode", "value": "", "type": "path" } ] }, "docs": "Retrieves the tax rate strategy object by Id and Country Code" }, { "info": { "name": "Update tax rate strategy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/taxrates/strategies/:id/:countryCode", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "countryCode", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specific tax rate strategy object" }, { "info": { "name": "Delete tax rate strategy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/taxrates/strategies/:id/:countryCode", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "countryCode", "value": "", "type": "path" } ] }, "docs": "Deletes the tax rate strategy object by Id and Country Code" }, { "info": { "name": "Get tax rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxrates", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Get all available tax rates. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned." }, { "info": { "name": "Add tax rate", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/taxrates", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new tax rate object" }, { "info": { "name": "Get tax rate by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxrates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieves the tax rate object by Id" }, { "info": { "name": "Update tax rate", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/taxrates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specific tax rate object" }, { "info": { "name": "Delete tax rate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/taxrates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes the tax rate object by Id. If successful the deleted tax rate object is returned" }, { "info": { "name": "Get tax rate strategies", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxrates/strategies", "params": [ { "name": "limit", "value": "", "type": "query", "description": "number of items per page" }, { "name": "pageToken", "value": "", "type": "query", "description": "pass this to subsequent calls" }, { "name": "fetchAll", "value": "", "type": "query", "description": "if true, returns all strategies ignoring pagination" } ] }, "docs": "Get all available tax rate strategies. The result is paginated unless fetchAll=true. To retrieve all results pass the cursor returned from a call to the next call until all results are returned." }, { "info": { "name": "Add tax rate strategy", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/taxrates/strategies", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new tax rate strategy object" }, { "info": { "name": "Get all tax rate strategies by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/taxrates/strategies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieves all tax rate strategy objects with the given Id" }, { "info": { "name": "Delete all tax rate strategies by Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/taxrates/strategies/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deletes all tax rate strategy objects with the given Id" }, { "info": { "name": "Get tenant details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/tenants" }, "docs": "Get the details of the current tenant" }, { "info": { "name": "Update tenant details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/tenants", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the current tenant based on the input" }, { "info": { "name": "Get tenant logo", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/tenants/logo" }, "docs": "Get the current logo stored" }, { "info": { "name": "Update tenant logo", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/tenants/logo", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Updates the logo used in external facing communication such as order forms and invoices" }, { "info": { "name": "Fetch UI customization config for the tenant", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/ui/customizations" }, "docs": "Fetch UI customization config for the tenant" }, { "info": { "name": "Update UI customization config for the tenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settings/ui/customizations", "body": { "type": "json", "data": "{}" } }, "docs": "Update UI customization config for the tenant" }, { "info": { "name": "Remove UI customization config for the tenant", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/settings/ui/customizations" }, "docs": "Remove UI customization config for the tenant" }, { "info": { "name": "Update DOCX settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings/docxSettings", "body": { "type": "json", "data": "{}" } }, "docs": "Update DOCX settings for your tenant" }, { "info": { "name": "Get plan replacement settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/autoReplacePlans" }, "docs": "Gets plan replacement settings" }, { "info": { "name": "Update plan replacement settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings/autoReplacePlans", "body": { "type": "json", "data": "{}" } }, "docs": "Update plan replacement settings" }, { "info": { "name": "Get payment term settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/paymentTerms" }, "docs": "Get payment term settings" }, { "info": { "name": "Update payment term settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings/paymentTerms", "body": { "type": "json", "data": "{}" } }, "docs": "Update payment term settings" }, { "info": { "name": "Get current billing cycle definitions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/billingCycle" }, "docs": "Get current billing cycle definitions" }, { "info": { "name": "Add new billing cycle definition", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settings/billingCycle", "body": { "type": "json", "data": "{}" } }, "docs": "Add new billing cycle definition" }, { "info": { "name": "Get billing cycle definition by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/billingCycle/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the billing cycle definition" } ] }, "docs": "Get billing cycle definition by id" }, { "info": { "name": "Update billing cycle definition", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings/billingCycle/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the billing cycle definition" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update billing cycle definition" }, { "info": { "name": "Get tenant settings", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings" }, "docs": "Returns all tenant settings for your tenant." }, { "info": { "name": "Update tenant settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings", "body": { "type": "json", "data": "{}" } }, "docs": "Updates settings for your tenant." }, { "info": { "name": "Set billing cycle with given id as default", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/settings/billingCycle/setDefault", "body": { "type": "json", "data": "{}" } }, "docs": "Set billing cycle with given id as default" }, { "info": { "name": "Get supported currencies", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/settings/supportedCurrencies" }, "docs": "Get supported currencies for your tenant" }, { "info": { "name": "Update supported currencies", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/settings/supportedCurrencies", "body": { "type": "json", "data": "{}" } }, "docs": "Update supported currencies for your tenant" }, { "info": { "name": "Get units of measure", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/unitsOfMeasure", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Returns a paginated list of units of measure" }, { "info": { "name": "Add unit of measure", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/unitsOfMeasure", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new instance of unit of measure as specified by the input" }, { "info": { "name": "Update unit of measure", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/unitsOfMeasure/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the unit of measure by Id provided." }, { "info": { "name": "Delete unit of measure", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/unitsOfMeasure/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete the unit of measure by Id provided. Returns the deleted unit of measure object if successful." }, { "info": { "name": "Activate unit of measure", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/unitsOfMeasure/:id/activate", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Activates the specified unit of measure making it available to be attached to charges" }, { "info": { "name": "Deprecate unit of measure", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/unitsOfMeasure/:id/deprecate", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Deprecates the specified unit of measure making it unavailable to be attached to charges going forward" } ] }, { "info": { "name": "Prismatic", "type": "folder" }, "items": [ { "info": { "name": "Get JSON Schema for a Prismatic object type", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/prismatic/schema", "params": [ { "name": "object", "value": "", "type": "query", "description": "Object type (ACCOUNT, INVOICE)" }, { "name": "tenantId", "value": "", "type": "query", "description": "Tenant ID" } ] }, "docs": "Returns JSON Schema for ACCOUNT, INVOICE, or CREDIT_MEMO objects. Used by Prismatic to render field mappings." }, { "info": { "name": "Get Prismatic app URL", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/prismatic/app-url" }, "docs": "Returns the Prismatic app URL if the Prismatic feature is enabled, null otherwise" }, { "info": { "name": "Generate Prismatic marketplace JWT", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/prismatic/marketplace-jwt" }, "docs": "Generates a signed JWT for authenticating the current user with Prismatic's embedded marketplace" }, { "info": { "name": "Trigger Prismatic invoice sync task", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/prismatic/syncInvoice/:invoiceId", "params": [ { "name": "invoiceId", "value": "", "type": "path" } ] }, "docs": "Trigger Prismatic invoice sync task for the given invoice id" }, { "info": { "name": "Check if Prismatic invoice sync is enabled", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/prismatic/syncInvoice/enabled" }, "docs": "Checks if Prismatic invoice sync is enabled" }, { "info": { "name": "Trigger Prismatic invoice sync tasks for multiple invoices", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/prismatic/syncInvoices", "body": { "type": "json", "data": "{}" } }, "docs": "Trigger Prismatic invoice sync tasks for the given list of invoice IDs" } ] }, { "info": { "name": "RateCard", "type": "folder" }, "items": [ { "info": { "name": "create a rate card using CSV price table multipart form data", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/ratecards/:id/csv", "params": [ { "name": "id", "value": "", "type": "path", "description": "rate card id" } ], "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "description", "type": "text", "value": "" }, { "name": "currency", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] } }, "docs": "create a rate card using the multipart form data, where a CSV can be passed in for the price table" }, { "info": { "name": "Fetch the list of rate cards stored in the system", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ratecards" }, "docs": "Fetch the list of rate cards stored in the system" }, { "info": { "name": "create a rate card using CSV price table multipart form data", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/ratecards/csv", "body": { "type": "multipart-form", "data": [ { "name": "name", "type": "text", "value": "" }, { "name": "description", "type": "text", "value": "" }, { "name": "currency", "type": "text", "value": "" }, { "name": "file", "type": "text", "value": "" } ] } }, "docs": "create a rate card using the multipart form data, where a CSV can be passed in for the price table" }, { "info": { "name": "Fetch the price attributes defined in the system in CSV format", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ratecards/attributes/csv" }, "docs": "Get all the price attributes in the system in CSV format one per row" }, { "info": { "name": "Import price attributes into the system", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/ratecards/attributes/csv", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Import the price attributes from an input CSV file, the output provides details on each row of the input" }, { "info": { "name": "Fetch the price table for the rate card given the id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/ratecards/:id/priceTable", "params": [ { "name": "id", "value": "", "type": "path", "description": "rate card id" } ] }, "docs": "Get the price table for the rate card given the id" } ] }, { "info": { "name": "Refunds", "type": "folder" }, "items": [ { "info": { "name": "Get refunds", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/refunds", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "id of the account" }, { "name": "creditMemoNumber", "value": "", "type": "query", "description": "id of a credit memo" } ] }, "docs": "Get all refunds for the specified account, OR if a credit memo number is specified in addition to the account id, get the details of only that." }, { "info": { "name": "Create and apply refund", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/refunds", "body": { "type": "json", "data": "{}" } }, "docs": "Creates and applies a refund per the specified parameters. On success the id of the refund is returned." }, { "info": { "name": "Get refund details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/refunds/:id", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "id of the account" }, { "name": "id", "value": "", "type": "path", "description": "id of the refund" } ] }, "docs": "Get the details of the specified refund." } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Run a report", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/reports/run", "body": { "type": "json", "data": "{}" } }, "docs": "Runs the specified report and returns the result as a csv." }, { "info": { "name": "Generate a report", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/reports/generate", "body": { "type": "json", "data": "{}" } }, "docs": "Generates a report with the specified parameters. This report can later be downloaded via /reports/{reportRunId}/result" }, { "info": { "name": "Run a generated report", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/reports/:reportRunId/result", "params": [ { "name": "reportRunId", "value": "", "type": "path", "description": "id of the report" } ] }, "docs": "Runs a report generated with /generate. On success a csv of the report is returned." }, { "info": { "name": "Get report definitions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/reports" }, "docs": "Returns the definitions of the reports defined for your tenant." } ] }, { "info": { "name": "Revenue Enablement", "type": "folder" }, "items": [ { "info": { "name": "Enable revenue recognition", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/revenueEnablement/enable" }, "docs": "This will enable revenue recognition" }, { "info": { "name": "Check if an open accounting period exists", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/readiness/doesOpenAccountingPeriodExist" }, "docs": "This will check if an open accounting period exists" }, { "info": { "name": "Check if all charges are tagged with revenue rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/readiness/areAllChargesTaggedWithRevenueRules" }, "docs": "This will check if all charges are tagged with revenue rules" }, { "info": { "name": "Check if all charges are tagged with GL accounts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/readiness/areAllChargesTaggedWithGLAccounts" }, "docs": "This will check if all charges are tagged with GL accounts" }, { "info": { "name": "Check if all order lines have schedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/readiness/doAllOrderLinesHaveSchedules" }, "docs": "This will check if all order lines have schedules" }, { "info": { "name": "Check if accounting events are present for all transaction types", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/readiness/areAccountingEventsPresentForAllTransactionTypes" }, "docs": "This will check if accounting events are present for all transaction types" }, { "info": { "name": "Get revenue enablement progress", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revenueEnablement/progress" }, "docs": "This will get revenue enablement progress" }, { "info": { "name": "Update revenue enablement progress", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/revenueEnablement/progress", "body": { "type": "json", "data": "{}" } }, "docs": "This will update revenue enablement progress" }, { "info": { "name": "Delete all accounting and revenue recognition data", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/revenueEnablement" }, "docs": "This will delete all accounting and revenue recognition data except for the charge configuration and ledger accounts" } ] }, { "info": { "name": "Revenue Recognition", "type": "folder" }, "items": [ { "info": { "name": "Get revenue recognition events", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/events", "params": [ { "name": "accountingPeriodId", "value": "", "type": "query", "description": "id of the accounting period to limit events to" }, { "name": "subscriptionId", "value": "", "type": "query", "description": "id of the subscription" }, { "name": "chargeId", "value": "", "type": "query", "description": "id of the charge" } ] }, "docs": "Gets revenue recognition events for the specified subscription and charge." }, { "info": { "name": "Create a revenue recognition event", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/revrec/events", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a revenue recognition event, only if it is different from the previous event for same subscription and charge." }, { "info": { "name": "Get revenue recognition rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/rules" }, "docs": "Get revenue recognition rules." }, { "info": { "name": "Create a revenue recognition rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/revrec/rules", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a revenue recognition rule." }, { "info": { "name": "Get revenue recognition rule", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/rules/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the recognition rule" } ] }, "docs": "Get a revenue recognition rule using id." }, { "info": { "name": "Delete a recognition rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/revrec/rules/:ruleId", "params": [ { "name": "ruleId", "value": "", "type": "path", "description": "id of the recognition rule" } ] }, "docs": "Deletes a recognition rule. Note you can't delete a recognition rule that's in use." }, { "info": { "name": "Create a bulk revenue recognition", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/revrec/bulk", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a bulk revenue recognition as specified by the input parameters. On success the id of the bulk revenue recognition is returned." }, { "info": { "name": "Get bulk revenue recognition details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/bulk/:bulkRevenueRecognitionId", "params": [ { "name": "bulkRevenueRecognitionId", "value": "", "type": "path", "description": "id of the bulk revenue recognition" } ] }, "docs": "Returns the details of the specified bulk revenue recognition" }, { "info": { "name": "Get items for bulk revenue recognition", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/bulk/:bulkRevenueRecognitionId/revrecItems", "params": [ { "name": "bulkRevenueRecognitionId", "value": "", "type": "path", "description": "id of the bulk revenue recognition" } ] }, "docs": "Returns the items associated with the specified bulk revenue recognition" }, { "info": { "name": "Download waterfall report", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/revrec/waterfall", "params": [ { "name": "startDate", "value": "", "type": "query", "description": "report start date as unix timestamp" }, { "name": "endDate", "value": "", "type": "query", "description": "report end date as unix timestamp" } ] }, "docs": "Downloads a revenue waterfall report in csv format." }, { "info": { "name": "Upload revenue events", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/revrec/events/upload", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Uploads revenue events from a csv file. The format of the file is\nSubscription.Id,Charge.Id,Alias.Id,RevrecEvent.PercentComplete\nPercent complete should be a decimal." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "Get subscription details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Gets the details of the specified subscription." }, { "info": { "name": "Update subscription details", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/subscriptions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the specified subscription." }, { "info": { "name": "Generate draft amendment order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/draftAmendment", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Generate a draft amendment object for the given subscription. The draft amendment is composed of current subscription charges as the default line items." }, { "info": { "name": "Generate draft renewal order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/draftRenewal", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Generate a draft renewal order object for the given subscription. The draft renewal is composed of current subscription charges as the default line items." }, { "info": { "name": "Subscription can be modified", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/modifiable", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Returns true if subscription can be deleted." }, { "info": { "name": "Subscription can be reverted", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/reversible", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Returns true if subscription can be reverted to a prior version." }, { "info": { "name": "Get billing periods", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/billingPeriods", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Gets the billing periods for the specified subscription." }, { "info": { "name": "Send test notifications for subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/subscriptions/:id/test-notifications", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" }, { "name": "notificationTargetId", "value": "", "type": "query", "description": "ID of the notification target to send tests to" } ] }, "docs": "Sends test notifications for the specified subscription to the specified notification target." }, { "info": { "name": "Get change events for subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/change-events", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Returns the scheduled change events for the specified subscription." }, { "info": { "name": "Get paginated subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions", "params": [ { "name": "limit", "value": "", "type": "query", "description": "number of items per page" }, { "name": "pageToken", "value": "", "type": "query", "description": "pass this to subsequent calls" }, { "name": "accountId", "value": "", "type": "query", "description": "optionally pass in account Id, only subscriptions for this account will will returned" } ] }, "docs": "returns all Subscriptions in the system in a paginated fashion" }, { "info": { "name": "Delete subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/subscriptions/:id/:version", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" }, { "name": "version", "value": "", "type": "path", "description": "subscription version" } ] }, "docs": "Deletes the subscription for given subscription Id if invoices have not been generated and revenue has not been recognized" }, { "info": { "name": "Revert subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/subscriptions/:id/:version/revert", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" }, { "name": "version", "value": "", "type": "path", "description": "subscription version" } ] }, "docs": "Reverts the subscription for given subscription Id and version to it's previous version. Operation is allowed only if invoices have not been generated and revenue has not been recognized" }, { "info": { "name": "Link renewal opportunity to subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/subscriptions/:id/renewalOpportunity", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" }, { "name": "renewalOpportunityCrmId", "value": "", "type": "query", "description": "renewal opportunity CRM id" } ] }, "docs": "Update renewal opportunity CRM id on subscription" }, { "info": { "name": "Get subscription metrics", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/subscriptions/:id/metrics", "params": [ { "name": "id", "value": "", "type": "path", "description": "id of the subscription" }, { "name": "targetDate", "value": "", "type": "query", "description": "As of date for the metrics. If omitted defaults to now." }, { "name": "forceRecalculate", "value": "", "type": "query", "description": "If true, forces recalculation of metrics instead of using cached values." } ] }, "docs": "Returns the metrics associated with the specified subscription. Metrics include ACV, ARR, etc." }, { "info": { "name": "Renew an existing subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/subscriptions/:subscriptionId/renew", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a renewal order for an existing subscription" }, { "info": { "name": "Get subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/subscriptions", "params": [ { "name": "buyerAccountId", "value": "", "type": "query", "description": "The buyer account ID" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" } ] }, "docs": "Get a paginated list of subscriptions (without line items) for a buyer account" }, { "info": { "name": "Get subscription details", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/subscriptions/:id/detail", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ] }, "docs": "Gets the details of the specified subscription." }, { "info": { "name": "Get subscription lines", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/subscriptions/:id/detail/lines", "params": [ { "name": "id", "value": "", "type": "path", "description": "subscription id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the line items for an existing subscription" }, { "info": { "name": "Get subscriptions with detail", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/subscriptions/detail", "params": [ { "name": "buyerAccountId", "value": "", "type": "query", "description": "The buyer account ID" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results per page" }, { "name": "effectiveDate", "value": "", "type": "query", "description": "Effective date in seconds since epoch" }, { "name": "includeExpiredLines", "value": "", "type": "query", "description": "Include expired line items" } ] }, "docs": "Get a paginated list of subscriptions with full details for a buyer account" }, { "info": { "name": "Amend an existing subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/subscriptions/:subscriptionId/amend", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an amendment order for an existing subscription" }, { "info": { "name": "Cancel an existing subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/subscriptions/:subscriptionId/cancel", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a cancellation order for an existing subscription" } ] }, { "info": { "name": "TemplateScript", "type": "folder" }, "items": [ { "info": { "name": "Fetch template scripts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/templateScript", "params": [ { "name": "templateType", "value": "", "type": "query" } ] }, "docs": "Returns a list of template scripts of a certain type" }, { "info": { "name": "Add a new template script", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/templateScript", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new template script" }, { "info": { "name": "Disable a template script", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/templateScript", "body": { "type": "json", "data": "{}" } }, "docs": "Disable a template script" } ] }, { "info": { "name": "Jobs", "type": "folder" }, "items": [ { "info": { "name": "Dispatch tenant job", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/tenantJobs/dispatch", "body": { "type": "json", "data": "{}" } }, "docs": "Executes a tenant job" }, { "info": { "name": "Retry tenant job", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/tenantJobs/retry", "params": [ { "name": "jobId", "value": "", "type": "query" } ] }, "docs": "Executes a tenant job" }, { "info": { "name": "Cancel tenant job", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/tenantJobs/:jobId/cancel", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job id" } ] }, "docs": "Cancels a tenant job. Any pending future tasks will be skipped" }, { "info": { "name": "Get tenant job", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/tenantJobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job id" } ] }, "docs": "Get tenant job by id" } ] }, { "info": { "name": "Foreign Exchange", "type": "folder" }, "items": [ { "info": { "name": "Refresh transactional exchange rates", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/fx/transactional/refresh", "params": [ { "name": "effectiveDate", "value": "", "type": "query" } ] }, "docs": "Refresh transactional exchange rates for all supported currencies to functional currencies for the given effective date" }, { "info": { "name": "Get latest transactional exchange rates", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/fx/transactional/latest" }, "docs": "Get latest transactional exchange rates for all currency pairs of supported currencies to functional currencies" }, { "info": { "name": "Get as of transactional exchange rate for a currency pair", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/fx/transactional/asof", "params": [ { "name": "fromCurrency", "value": "", "type": "query" }, { "name": "toCurrency", "value": "", "type": "query" }, { "name": "asOf", "value": "", "type": "query" } ] }, "docs": "Get transactional exchange rate for a currency pair as of a specific date" }, { "info": { "name": "Refresh transactional exchange rate by currency pair", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/fx/transactional/refreshPair", "params": [ { "name": "fromCurrency", "value": "", "type": "query" }, { "name": "toCurrency", "value": "", "type": "query" }, { "name": "effectiveDate", "value": "", "type": "query" } ] }, "docs": "Fetch and store transactional exchange rate for given currency pair and effective date from exchange rate provider" } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Get user groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/userGroups" }, "docs": "Get all available user groups" }, { "info": { "name": "Add user group", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/userGroups", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user group based on the parameters in the input" }, { "info": { "name": "Update user group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/userGroups", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified user group according to the input" }, { "info": { "name": "Get user group", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/userGroups/:userGroupId", "params": [ { "name": "userGroupId", "value": "", "type": "path" } ] }, "docs": "Retrieve a user group by Id" }, { "info": { "name": "Delete user group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.app.subskribe.com/userGroups/:userGroupId", "params": [ { "name": "userGroupId", "value": "", "type": "path" } ] }, "docs": "Delete the user group by Id" }, { "info": { "name": "Bulk user upload", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/users/upload" }, "docs": "Loads a list of users to be added to in CSV format." }, { "info": { "name": "Resend welcome email", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/users/resend-email/:email", "params": [ { "name": "email", "value": "", "type": "path" } ] }, "docs": "Resend welcome email conditioning temporary credentials. This is required if the user does not register within 24 hours of user activation" }, { "info": { "name": "Get users list", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/users", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Returns a paginated list of users" }, { "info": { "name": "Add a new user", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/users", "body": { "type": "json", "data": "{}" } }, "docs": "Add a new user to the system. Users in the system must have unique emails. If successful, the path to the new user object is returned and a welcome email containing a temporary password will be sent to the email associated with the user. The login credentials expires in 24 hours. If the user does not login to the system within that time, a new invitation is required." }, { "info": { "name": "Accept terms and conditions", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/users/terms-and-conditions" }, "docs": "Before a user gains access to the application, they must accept Subskribe's terms and conditions. This operation requires user bound access tokens." }, { "info": { "name": "Disable user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/users/disable/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disables a user by Id. If successful, returns the user just disabled" }, { "info": { "name": "Enable user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/users/enable/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Enables a user by Id. If successful, returns the user just enabled" }, { "info": { "name": "Get user by Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Returns a specific user by Id" }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the user information. Email cannot be updated." }, { "info": { "name": "Update user SSO configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/users/:id/sso", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Toggle user SSO configuration by user Id." } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "getCpqSourcedAccount", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" } ] } }, { "info": { "name": "updateCpqSourcedAccount", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/rh/accounts/:accountId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "addCpqSourcedAccount", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/accounts", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getCpqSourcedAccounts", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/accounts/bulk", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getCpqSourcedAccountsByUvcaCfacId", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/accounts/cfac-id", "params": [ { "name": "uvcaCfacId", "value": "", "type": "query", "description": "uvca_cfac_id" } ] } }, { "info": { "name": "getCpqSourcedAccountContacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/accounts/:accountId/contacts", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" } ] } }, { "info": { "name": "addCpqSourcedAccountContact", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/accounts/:accountId/contacts", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "getCpqSourcedAccountContact", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/accounts/:accountId/contacts/:contactId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" }, { "name": "contactId", "value": "", "type": "path", "description": "The unique contact identifier" } ] } }, { "info": { "name": "updateCpqSourcedAccountContact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.app.subskribe.com/rh/accounts/:accountId/contacts/:contactId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique account identifier" }, { "name": "contactId", "value": "", "type": "path", "description": "The unique contact identifier" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "Invoice", "type": "folder" }, "items": [ { "info": { "name": "getCpqSourcedAccountInvoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/invoices", "params": [ { "name": "accountId", "value": "", "type": "query", "description": "Required. Filter invoices to this account." }, { "name": "status", "value": "", "type": "query", "description": "Optional invoice status filter (DRAFT, POSTED, VOIDED)." }, { "name": "pageToken", "value": "", "type": "query", "description": "Pass the pageToken returned from a prior call to fetch the next page." }, { "name": "limit", "value": "", "type": "query", "description": "Page size (default 20)." } ] } } ] }, { "info": { "name": "Order", "type": "folder" }, "items": [ { "info": { "name": "Get an order by its identifier", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/orders/:orderIdentifier", "params": [ { "name": "orderIdentifier", "value": "", "type": "path", "description": "The order identifier" } ] }, "docs": "Get an order by its identifier" }, { "info": { "name": "Compute memoized invoice line items for given order", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/orders/:orderIdentifier/memoizedInvoiceItems", "params": [ { "name": "orderIdentifier", "value": "", "type": "path", "description": "The order identifier" }, { "name": "roundingAllocation", "value": "", "type": "query", "description": "rounding allocation for memoization, defaults to LAST_ELEMENT if not present" } ] }, "docs": "Compute memoized invoice line items for given order" }, { "info": { "name": "postBillableOrder", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/orders", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Run a search query", "type": "http" }, "http": { "method": "GET", "url": "https://api.app.subskribe.com/rh/search", "params": [ { "name": "query", "value": "", "type": "query", "description": "query to run" } ] }, "docs": "Runs the specified search query" }, { "info": { "name": "Run a search query (POST)", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/search", "body": { "type": "json", "data": "{}" } }, "docs": "Same as GET /rh/search but accepts the query in the request body. Use when the query JSON is too large to fit in a URL (e.g. terms clauses with hundreds of ids)." } ] }, { "info": { "name": "Product Provisioning", "type": "folder" }, "items": [ { "info": { "name": "syncSkus", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/product-provisioning", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "Tenant", "type": "folder" }, "items": [ { "info": { "name": "createRevHubTenant", "type": "http" }, "http": { "method": "POST", "url": "https://api.app.subskribe.com/rh/tenants", "body": { "type": "json", "data": "{}" } } } ] } ], "bundled": true }