Stripe Connector
Documentation
Version: 2
Documentation

EndPoints for Stripe Connector


On this page you will see possible API actions you can perform with Stripe connector. We will refer this as API EndPoint or just EndPoint.

Label Name Description
Test Connection test_connection Tests connection [API Help..]
List All Customers get_customers Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. [API Help..]
Retrieve a Customer get_single_customer Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation. [API Help..]
Delete a Customer delete_customer Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer. [API Help..]
Create a Customer create_customer Create a Customer [API Help..]
Update a Customer update_customer Updates the specified customer by setting the values of the parameters passed. [API Help..]
List All Products get_products Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first. [API Help..]
Retrieve a single Product get_single_product Retrieves the details of an existing product. Supply the unique product Id from either a product creation request or the product list, and Stripe will return the corresponding product information. [API Help..]
Delete a Product delete_product Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it. [API Help..]
Create a Product create_product Creates a new product. [API Help..]
Update a Product update_product Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. [API Help..]
List All Subscriptions get_subscriptions Returns a list of subscriptions. [API Help..]
List All Subscriptions Items get_subscription_items Returns a list of subscriptions items. [API Help..]
Retrieve a single Subscription get_single_subscription Returns a single subscription. [API Help..]
List All Invoices get_invoices You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [API Help..]
Retrieve an Invoice get_single_invoice Retrieves the invoice with the given Id. [API Help..]
Delete a Draft Invoice delete_invoice Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be voided. [API Help..]
Finalize an Invoice finalize_invoice Stripe automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method. [API Help..]
Pay an Invoice pay_invoice Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so. [API Help..]
Send an Invoice For Manual Payment send_invoice Send an Invoice For Manual Payment [API Help..]
Void an Invoice void_invoice Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found. [API Help..]
Mark an Invoice As Uncollectible mark_uncollectible_invoice Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes. [API Help..]
Retrieve an Invoice Line Items get_invoice_lines When retrieving an invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. [API Help..]
Retrieve an Upcoming Invoice get_upcoming_invoice At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice. [API Help..]
Retrieve an Upcoming Invoice Line Items upcoming_invoice_lines When retrieving an upcoming invoice, you’ll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. [API Help..]
Create an Invoice create_invoice This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay or send the invoice to your customers. [API Help..]
Update an Invoice update_invoice Draft invoices are fully editable. Once an invoice is finalized, monetary values, as well as collection_method, become uneditable. [API Help..]
Create an Invoice Item create_invoice_item Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified. [API Help..]
List All Invoice Items get_invoice_items Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first. [API Help..]
Retrieve an Invoice Item get_invoice_item Retrieves the invoice item with the given Id. [API Help..]
Delete an Invoice Item delete_invoice_item Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice. [API Help..]
Update an Invoice Item update_invoice_item Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed. [API Help..]
List All Quotes get_quotes You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. [API Help..]
Generic Request generic_request This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.