{
  "opencollection": "1.0.0",
  "info": {
    "name": "Stripe Accounts Account Credit Notes API",
    "version": "2023-10-16"
  },
  "items": [
    {
      "info": {
        "name": "Credit Notes",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GetCreditNotes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/credit_notes",
            "params": [
              {
                "name": "customer",
                "value": "",
                "type": "query",
                "description": "Only return credit notes for the customer specified by this customer ID."
              },
              {
                "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 credit notes for the invoice specified by this invoice ID."
              },
              {
                "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>Returns a list of credit notes.</p>"
        },
        {
          "info": {
            "name": "PostCreditNotes",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/credit_notes",
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Issue a credit note to adjust the amount of a finalized invoice. For a <code>status=open</code> invoice, a credit note reduces\nits <code>amount_due</code>. For a <code>status=paid</code> invoice, a credit note does not affect its <code>amount_due</code>. Instead, it can result\nin any combination of the following:</p>\n\n<ul>\n<li>Refund: create a new refund (using <code>refund_amount</code>) or link an existing refund (using <code>refund</code>).</li>\n<li>Customer balance credit: credit the cust"
        },
        {
          "info": {
            "name": "GetCreditNotesPreview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/credit_notes/preview",
            "params": [
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note."
              },
              {
                "name": "credit_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice."
              },
              {
                "name": "effective_at",
                "value": "",
                "type": "query",
                "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "invoice",
                "value": "",
                "type": "query",
                "description": "ID of the invoice."
              },
              {
                "name": "lines",
                "value": "",
                "type": "query",
                "description": "Line items that make up the credit note."
              },
              {
                "name": "memo",
                "value": "",
                "type": "query",
                "description": "The credit note's memo appears on the credit note PDF."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
              },
              {
                "name": "out_of_band_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe."
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`"
              },
              {
                "name": "refund",
                "value": "",
                "type": "query",
                "description": "ID of an existing refund to link this credit note to."
              },
              {
                "name": "refund_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice."
              },
              {
                "name": "shipping_cost",
                "value": "",
                "type": "query",
                "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note."
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Get a preview of a credit note without creating it.</p>"
        },
        {
          "info": {
            "name": "GetCreditNotesPreviewLines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/credit_notes/preview/lines",
            "params": [
              {
                "name": "amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note."
              },
              {
                "name": "credit_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice."
              },
              {
                "name": "effective_at",
                "value": "",
                "type": "query",
                "description": "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF."
              },
              {
                "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": "ID of the invoice."
              },
              {
                "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": "lines",
                "value": "",
                "type": "query",
                "description": "Line items that make up the credit note."
              },
              {
                "name": "memo",
                "value": "",
                "type": "query",
                "description": "The credit note's memo appears on the credit note PDF."
              },
              {
                "name": "metadata",
                "value": "",
                "type": "query",
                "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
              },
              {
                "name": "out_of_band_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe."
              },
              {
                "name": "reason",
                "value": "",
                "type": "query",
                "description": "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`"
              },
              {
                "name": "refund",
                "value": "",
                "type": "query",
                "description": "ID of an existing refund to link this credit note to."
              },
              {
                "name": "refund_amount",
                "value": "",
                "type": "query",
                "description": "The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice."
              },
              {
                "name": "shipping_cost",
                "value": "",
                "type": "query",
                "description": "When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note."
              },
              {
                "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 a credit note preview, you’ll get a <strong>lines</strong> property containing the first handful of those items. This URL you can retrieve the full (paginated) list of line items.</p>"
        },
        {
          "info": {
            "name": "GetCreditNotesCreditNoteLines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/credit_notes/:credit_note/lines",
            "params": [
              {
                "name": "credit_note",
                "value": "",
                "type": "path"
              },
              {
                "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": "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 a credit note, you’ll get a <strong>lines</strong> property containing the 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": "GetCreditNotesId",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.stripe.com/v1/credit_notes/:id",
            "params": [
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Specifies which fields in the response should be expanded."
              },
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Retrieves the credit note object with the given identifier.</p>"
        },
        {
          "info": {
            "name": "PostCreditNotesId",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/credit_notes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Updates an existing credit note.</p>"
        },
        {
          "info": {
            "name": "PostCreditNotesIdVoid",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.stripe.com/v1/credit_notes/:id/void",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": []
            }
          },
          "docs": "<p>Marks a credit note as void. Learn more about <a href=\"/docs/billing/invoices/credit-notes#voiding\">voiding credit notes</a>.</p>"
        }
      ]
    }
  ],
  "bundled": true
}