{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stripe Accounts Account Invoice API",
    "version": "2023-10-16"
  },
  "items": [
    {
      "info": {
        "name": "Invoice",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Stripe Get   Invoice Items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/Invoice Items",
            "params": [
              {
                "name": "created",
                "value": "",
                "type": "query"
              },
              {
                "name": "customer",
                "value": "",
                "type": "query",
                "description": "The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned."
              },
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "invoice",
                "value": "",
                "type": "query",
                "description": "Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
              },
              {
                "name": "pending",
                "value": "",
                "type": "query",
                "description": "Set to `true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied."
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoice Items",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/Invoice Items",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>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.</p>"
        },
        {
          "info": {
            "name": "Stripe Get   Invoice Items",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/Invoice Items/:invoiceitem",
            "params": [
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "invoiceitem",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the invoice item with the given ID.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoice Items",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/Invoice Items/:invoiceitem",
            "params": [
              {
                "name": "invoiceitem",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>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.</p>"
        },
        {
          "info": {
            "name": "Stripe Delete   Invoice Items",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.stripe.com/v1/Invoice Items/:invoiceitem",
            "params": [
              {
                "name": "invoiceitem",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>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.</p>"
        },
        {
          "info": {
            "name": "Stripe Get   Invoices Invoice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/invoices/:invoice",
            "params": [
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the invoice with the given ID.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Draft invoices are fully editable. Once an invoice is <a href=\"/docs/billing/invoices/workflow#finalized\">finalized</a>,\nmonetary values, as well as <code>collection_method</code>, become uneditable.</p>\n\n<p>If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,\nsending reminders for, or <a href=\"/docs/billing/invoices/reconciliation\">automatically reconciling</a> invoices, pass\n<code>auto_advance=false</code>.</p>"
        },
        {
          "info": {
            "name": "Stripe Delete   Invoices Invoice",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.stripe.com/v1/invoices/:invoice",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>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 <a href=\"#void_invoice\">voided</a>.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Finalize",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/finalize",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>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.</p>"
        },
        {
          "info": {
            "name": "Stripe Get   Invoices Invoice Lines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/invoices/:invoice/lines",
            "params": [
              {
                "name": "ending_before",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10."
              },
              {
                "name": "starting_after",
                "value": "",
                "type": "query",
                "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>When retrieving an invoice, you’ll get a <strong>lines</strong> 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.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Lines Line Item Id",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/lines/:line_item_id",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path",
                "description": "Invoice ID of line item"
              },
              {
                "name": "line_item_id",
                "value": "",
                "type": "path",
                "description": "Invoice line item ID"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Updates an invoice’s line item. Some fields, such as <code>tax_amounts</code>, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as <code>amount</code>, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Mark Uncollectible",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/mark_uncollectible",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Pay",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/pay",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your <a href=\"https://dashboard.stripe.com/account/billing/automatic\">subscriptions settings</a>. 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.</p>"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Send",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/send",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Stripe will automatically send invoices to customers according to your <a href=\"https://dashboard.stripe.com/account/billing/automatic\">subscriptions settings</a>. However, if you’d like to manually send an invoice to your customer out of the normal schedule, you can do so. When sending invoices that have already been paid, there will be no reference to the payment in the email.</p>\n\n<p>Requests made in test-mode result in no emails being sent, despite sending an <code>invoice.sent</code> eve"
        },
        {
          "info": {
            "name": "Stripe Post   Invoices Invoice Void",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/invoices/:invoice/void",
            "params": [
              {
                "name": "invoice",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to <a href=\"#delete_invoice\">deletion</a>, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.</p>"
        }
      ]
    }
  ],
  "bundled": true
}