Mark invoice as paid

curl --request POST \
  --url https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_received_date": "2023-12-25",
  "external_id": "external_payment_id_123",
  "notes": "<string>"
}
'

import requests

url = "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid"

payload = {
    "payment_received_date": "2023-12-25",
    "external_id": "external_payment_id_123",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_received_date: '2023-12-25',
    external_id: 'external_payment_id_123',
    notes: '<string>'
  })
};

fetch('https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_received_date' => '2023-12-25',
    'external_id' => 'external_payment_id_123',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid"

	payload := strings.NewReader("{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "metadata": {},
  "voided_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "scheduled_issue_at": "2023-11-07T05:31:56Z",
  "auto_collection": {
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "previously_attempted_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "num_attempts": 123
  },
  "issue_failed_at": "2023-11-07T05:31:56Z",
  "sync_failed_at": "2023-11-07T05:31:56Z",
  "payment_failed_at": "2023-11-07T05:31:56Z",
  "payment_started_at": "2023-11-07T05:31:56Z",
  "amount_due": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer": {
    "id": "<string>",
    "external_customer_id": "<string>"
  },
  "due_date": "2022-05-30T07:00:00+00:00",
  "id": "<string>",
  "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
  "invoice_number": "<string>",
  "subscription": {
    "id": "<string>"
  },
  "total": "<string>",
  "customer_balance_transactions": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "starting_balance": "<string>",
      "ending_balance": "<string>",
      "amount": "<string>",
      "description": "An optional description",
      "invoice": {
        "id": "<string>"
      },
      "credit_note": {
        "id": "<string>"
      }
    }
  ],
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "hosted_invoice_url": "<string>",
  "will_auto_issue": true,
  "eligible_to_issue_at": "2023-11-07T05:31:56Z",
  "customer_tax_id": {
    "value": "<string>"
  },
  "memo": "<string>",
  "credit_notes": [
    {
      "id": "<string>",
      "credit_note_number": "<string>",
      "reason": "<string>",
      "total": "<string>",
      "voided_at": "2022-05-01T07:01:31+00:00",
      "type": "<string>",
      "memo": "<string>"
    }
  ],
  "payment_attempts": [
    {
      "id": "<string>",
      "payment_provider_id": "<string>",
      "amount": "<string>",
      "succeeded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
    }
  ],
  "discount": "<unknown>",
  "discounts": [
    {
      "discount_type": "percentage",
      "percentage_discount": 0.5,
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "filters": [
        {
          "values": [
            "<string>"
          ]
        }
      ],
      "reason": "<string>"
    }
  ],
  "minimum": {
    "minimum_amount": "<string>",
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>",
  "line_items": [
    {
      "amount": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "grouping": "<string>",
      "adjustments": [
        {
          "id": "<string>",
          "is_invoice_level": true,
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "replaces_adjustment_id": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "amount": "<string>"
        }
      ],
      "name": "<string>",
      "quantity": 123,
      "start_date": "2023-11-07T05:31:56Z",
      "subtotal": "<string>",
      "adjusted_subtotal": "<string>",
      "credits_applied": "<string>",
      "partially_invoiced_amount": "<string>",
      "sub_line_items": [
        {
          "amount": "<string>",
          "name": "<string>",
          "quantity": 123,
          "grouping": {
            "key": "<string>",
            "value": "west"
          },
          "type": "matrix",
          "matrix_config": {
            "dimension_values": [
              "<string>"
            ]
          },
          "scaled_quantity": 123
        }
      ],
      "tax_amounts": [
        {
          "tax_rate_description": "<string>",
          "tax_rate_percentage": "<string>",
          "amount": "<string>"
        }
      ],
      "id": "<string>",
      "price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "replaces_price_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "billable_metric": {
          "id": "<string>"
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true,
          "custom_expiration": {
            "duration": 123
          },
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "license_type_id": "<string>"
        },
        "composite_price_filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "invoice_grouping_key": "<string>",
        "discount": {
          "discount_type": "percentage",
          "percentage_discount": 0.5,
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "reason": "<string>"
        },
        "minimum": {
          "minimum_amount": "<string>",
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "license_type": {
          "id": "<string>",
          "name": "<string>",
          "grouping_key": "<string>"
        }
      },
      "usage_customer_ids": [
        "<string>"
      ],
      "filter": "<string>"
    }
  ],
  "subtotal": "<string>",
  "invoice_date": "2023-11-07T05:31:56Z"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

POST

invoices

{invoice_id}

mark_paid

Mark invoice as paid

curl --request POST \
  --url https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment_received_date": "2023-12-25",
  "external_id": "external_payment_id_123",
  "notes": "<string>"
}
'

import requests

url = "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid"

payload = {
    "payment_received_date": "2023-12-25",
    "external_id": "external_payment_id_123",
    "notes": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    payment_received_date: '2023-12-25',
    external_id: 'external_payment_id_123',
    notes: '<string>'
  })
};

fetch('https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'payment_received_date' => '2023-12-25',
    'external_id' => 'external_payment_id_123',
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid"

	payload := strings.NewReader("{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withorb.com/v1/invoices/{invoice_id}/mark_paid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payment_received_date\": \"2023-12-25\",\n  \"external_id\": \"external_payment_id_123\",\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "metadata": {},
  "voided_at": "2023-11-07T05:31:56Z",
  "paid_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "scheduled_issue_at": "2023-11-07T05:31:56Z",
  "auto_collection": {
    "next_attempt_at": "2023-11-07T05:31:56Z",
    "previously_attempted_at": "2023-11-07T05:31:56Z",
    "enabled": true,
    "num_attempts": 123
  },
  "issue_failed_at": "2023-11-07T05:31:56Z",
  "sync_failed_at": "2023-11-07T05:31:56Z",
  "payment_failed_at": "2023-11-07T05:31:56Z",
  "payment_started_at": "2023-11-07T05:31:56Z",
  "amount_due": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "currency": "<string>",
  "customer": {
    "id": "<string>",
    "external_customer_id": "<string>"
  },
  "due_date": "2022-05-30T07:00:00+00:00",
  "id": "<string>",
  "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
  "invoice_number": "<string>",
  "subscription": {
    "id": "<string>"
  },
  "total": "<string>",
  "customer_balance_transactions": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "starting_balance": "<string>",
      "ending_balance": "<string>",
      "amount": "<string>",
      "description": "An optional description",
      "invoice": {
        "id": "<string>"
      },
      "credit_note": {
        "id": "<string>"
      }
    }
  ],
  "shipping_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "billing_address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "hosted_invoice_url": "<string>",
  "will_auto_issue": true,
  "eligible_to_issue_at": "2023-11-07T05:31:56Z",
  "customer_tax_id": {
    "value": "<string>"
  },
  "memo": "<string>",
  "credit_notes": [
    {
      "id": "<string>",
      "credit_note_number": "<string>",
      "reason": "<string>",
      "total": "<string>",
      "voided_at": "2022-05-01T07:01:31+00:00",
      "type": "<string>",
      "memo": "<string>"
    }
  ],
  "payment_attempts": [
    {
      "id": "<string>",
      "payment_provider_id": "<string>",
      "amount": "<string>",
      "succeeded": true,
      "created_at": "2023-11-07T05:31:56Z",
      "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
    }
  ],
  "discount": "<unknown>",
  "discounts": [
    {
      "discount_type": "percentage",
      "percentage_discount": 0.5,
      "applies_to_price_ids": [
        "h74gfhdjvn7ujokd",
        "7hfgtgjnbvc3ujkl"
      ],
      "filters": [
        {
          "values": [
            "<string>"
          ]
        }
      ],
      "reason": "<string>"
    }
  ],
  "minimum": {
    "minimum_amount": "<string>",
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "minimum_amount": "<string>",
  "maximum": {
    "maximum_amount": "<string>",
    "filters": [
      {
        "values": [
          "<string>"
        ]
      }
    ],
    "applies_to_price_ids": [
      "<string>"
    ]
  },
  "maximum_amount": "<string>",
  "line_items": [
    {
      "amount": "<string>",
      "end_date": "2023-11-07T05:31:56Z",
      "grouping": "<string>",
      "adjustments": [
        {
          "id": "<string>",
          "is_invoice_level": true,
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "replaces_adjustment_id": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "amount": "<string>"
        }
      ],
      "name": "<string>",
      "quantity": 123,
      "start_date": "2023-11-07T05:31:56Z",
      "subtotal": "<string>",
      "adjusted_subtotal": "<string>",
      "credits_applied": "<string>",
      "partially_invoiced_amount": "<string>",
      "sub_line_items": [
        {
          "amount": "<string>",
          "name": "<string>",
          "quantity": 123,
          "grouping": {
            "key": "<string>",
            "value": "west"
          },
          "type": "matrix",
          "matrix_config": {
            "dimension_values": [
              "<string>"
            ]
          },
          "scaled_quantity": 123
        }
      ],
      "tax_amounts": [
        {
          "tax_rate_description": "<string>",
          "tax_rate_percentage": "<string>",
          "amount": "<string>"
        }
      ],
      "id": "<string>",
      "price": {
        "model_type": "unit",
        "unit_config": {
          "unit_amount": "<string>",
          "prorated": false
        },
        "metadata": {},
        "id": "<string>",
        "name": "<string>",
        "external_price_id": "<string>",
        "replaces_price_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "billing_cycle_configuration": {
          "duration": 123
        },
        "invoicing_cycle_configuration": {
          "duration": 123
        },
        "billable_metric": {
          "id": "<string>"
        },
        "fixed_price_quantity": 123,
        "plan_phase_order": 123,
        "currency": "<string>",
        "conversion_rate": 123,
        "conversion_rate_config": {
          "conversion_rate_type": "unit",
          "unit_config": {
            "unit_amount": "<string>"
          }
        },
        "item": {
          "id": "<string>",
          "name": "<string>"
        },
        "credit_allocation": {
          "currency": "<string>",
          "allows_rollover": true,
          "custom_expiration": {
            "duration": 123
          },
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "license_type_id": "<string>"
        },
        "composite_price_filters": [
          {
            "values": [
              "<string>"
            ]
          }
        ],
        "invoice_grouping_key": "<string>",
        "discount": {
          "discount_type": "percentage",
          "percentage_discount": 0.5,
          "applies_to_price_ids": [
            "h74gfhdjvn7ujokd",
            "7hfgtgjnbvc3ujkl"
          ],
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "reason": "<string>"
        },
        "minimum": {
          "minimum_amount": "<string>",
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "minimum_amount": "<string>",
        "maximum": {
          "maximum_amount": "<string>",
          "filters": [
            {
              "values": [
                "<string>"
              ]
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ]
        },
        "maximum_amount": "<string>",
        "dimensional_price_configuration": {
          "dimensional_price_group_id": "<string>",
          "dimension_values": [
            "<string>"
          ]
        },
        "license_type": {
          "id": "<string>",
          "name": "<string>",
          "grouping_key": "<string>"
        }
      },
      "usage_customer_ids": [
        "<string>"
      ],
      "filter": "<string>"
    }
  ],
  "subtotal": "<string>",
  "invoice_date": "2023-11-07T05:31:56Z"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#400-constraint-violation",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
  "status": 401,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#404-feature-not-available",
  "status": 400,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
  "status": 409,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#413-request-too-large",
  "status": 413,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
  "status": 429,
  "detail": "<string>",
  "title": "<string>"
}

{
  "type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
  "status": 123,
  "detail": "<string>",
  "title": "<string>"
}

Authorizations

Authorization

string

header

required

API Keys can be issued in the Orb's web application.

Path Parameters

invoice_id

string

required

Body

application/json

payment_received_date

string<date>

required

A date string to specify the date of the payment.

Example:

"2023-09-22"

external_id

string | null

An optional external ID to associate with the payment.

Example:

"external_payment_id_123"

notes

string | null

An optional note to associate with the payment.

Response

An Invoice is a fundamental billing entity, representing the request for payment for a single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and can represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as the result of an action, such as a cancellation.

metadata

Metadata · object

required

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Show child attributes

voided_at

string<date-time> | null

required

If the invoice has a status of void, this gives a timestamp when the invoice was voided.

paid_at

string<date-time> | null

required

If the invoice has a status of paid, this gives a timestamp when the invoice was paid.

issued_at

string<date-time> | null

required

If the invoice has been issued, this will be the time it transitioned to issued (even if it is now in a different state.)

scheduled_issue_at

string<date-time> | null

required

If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued.

auto_collection

AutoCollection · object

required

Show child attributes

issue_failed_at

string<date-time> | null

required

If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)

sync_failed_at

string<date-time> | null

required

If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be null for invoices using Orb Invoicing.

payment_failed_at

string<date-time> | null

required

If payment was attempted on this invoice but failed, this will be the time of the most recent attempt.

payment_started_at

string<date-time> | null

required

If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more.

amount_due

string

required

This is the final amount required to be charged to the customer and reflects the application of the customer balance to the total of the invoice.

Example:

"8.00"

created_at

string<date-time>

required

The creation time of the resource in Orb.

Example:

"2022-05-01T07:01:31+00:00"

currency

string

required

An ISO 4217 currency string or credits

Example:

"USD"

customer

CustomerMinified · object

required

Show child attributes

due_date

string<date-time> | null

required

When the invoice payment is due. The due date is null if the invoice is not yet finalized.

Example:

"2022-05-30T07:00:00+00:00"

string

required

invoice_pdf

string | null

required

The link to download the PDF representation of the Invoice.

Example:

"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"

invoice_number

string

required

Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as RFOBWG. These can be sequential per account or customer.

Example:

"JYEFHK-00001"

subscription

SubscriptionMinified · object | null

required

Show child attributes

total

string

required

The total after any minimums and discounts have been applied.

Example:

"8.00"

customer_balance_transactions

CustomerBalanceTransaction · object[]

required

Show child attributes

status

enum<string>

required

Available options:

issued,

paid,

synced,

void,

draft

invoice_source

enum<string>

required

Available options:

subscription,

partial,

one_off

shipping_address

Address · object | null

required

Show child attributes

billing_address

Address · object | null

required

Show child attributes

hosted_invoice_url

string | null

required

A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date — whichever is later.

will_auto_issue

boolean

required

This is true if the invoice will be automatically issued in the future, and false otherwise.

eligible_to_issue_at

string<date-time> | null

required

If the invoice has a status of draft, this will be the time that the invoice will be eligible to be issued, otherwise it will be null. If auto-issue is true, the invoice will automatically begin issuing at this time.

customer_tax_id

CustomerTaxId · object | null

required

Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.

Supported Tax ID Countries and Types

Country	Type	Description
Albania	`al_tin`	Albania Tax Identification Number
Andorra	`ad_nrt`	Andorran NRT Number
Angola	`ao_tin`	Angola Tax Identification Number
Argentina	`ar_cuit`	Argentinian Tax ID Number
Armenia	`am_tin`	Armenia Tax Identification Number
Aruba	`aw_tin`	Aruba Tax Identification Number
Australia	`au_abn`	Australian Business Number (AU ABN)
Australia	`au_arn`	Australian Taxation Office Reference Number
Austria	`eu_vat`	European VAT Number
Azerbaijan	`az_tin`	Azerbaijan Tax Identification Number
Bahamas	`bs_tin`	Bahamas Tax Identification Number
Bahrain	`bh_vat`	Bahraini VAT Number
Bangladesh	`bd_bin`	Bangladesh Business Identification Number
Barbados	`bb_tin`	Barbados Tax Identification Number
Belarus	`by_tin`	Belarus TIN Number
Belgium	`eu_vat`	European VAT Number
Benin	`bj_ifu`	Benin Tax Identification Number (Identifiant Fiscal Unique)
Bolivia	`bo_tin`	Bolivian Tax ID
Bosnia and Herzegovina	`ba_tin`	Bosnia and Herzegovina Tax Identification Number
Brazil	`br_cnpj`	Brazilian CNPJ Number
Brazil	`br_cpf`	Brazilian CPF Number
Bulgaria	`bg_uic`	Bulgaria Unified Identification Code
Bulgaria	`eu_vat`	European VAT Number
Burkina Faso	`bf_ifu`	Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique)
Cambodia	`kh_tin`	Cambodia Tax Identification Number
Cameroon	`cm_niu`	Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique)
Canada	`ca_bn`	Canadian BN
Canada	`ca_gst_hst`	Canadian GST/HST Number
Canada	`ca_pst_bc`	Canadian PST Number (British Columbia)
Canada	`ca_pst_mb`	Canadian PST Number (Manitoba)
Canada	`ca_pst_sk`	Canadian PST Number (Saskatchewan)
Canada	`ca_qst`	Canadian QST Number (Québec)
Cape Verde	`cv_nif`	Cape Verde Tax Identification Number (Número de Identificação Fiscal)
Chile	`cl_tin`	Chilean TIN
China	`cn_tin`	Chinese Tax ID
Colombia	`co_nit`	Colombian NIT Number
Congo-Kinshasa	`cd_nif`	Congo (DR) Tax Identification Number (Número de Identificação Fiscal)
Costa Rica	`cr_tin`	Costa Rican Tax ID
Croatia	`eu_vat`	European VAT Number
Croatia	`hr_oib`	Croatian Personal Identification Number (OIB)
Cyprus	`eu_vat`	European VAT Number
Czech Republic	`eu_vat`	European VAT Number
Denmark	`eu_vat`	European VAT Number
Dominican Republic	`do_rcn`	Dominican RCN Number
Ecuador	`ec_ruc`	Ecuadorian RUC Number
Egypt	`eg_tin`	Egyptian Tax Identification Number
El Salvador	`sv_nit`	El Salvadorian NIT Number
Estonia	`eu_vat`	European VAT Number
Ethiopia	`et_tin`	Ethiopia Tax Identification Number
European Union	`eu_oss_vat`	European One Stop Shop VAT Number for non-Union scheme
Faroe Islands	`fo_vat`	Faroe Islands VAT Number
Finland	`eu_vat`	European VAT Number
France	`eu_vat`	European VAT Number
Georgia	`ge_vat`	Georgian VAT
Germany	`de_stn`	German Tax Number (Steuernummer)
Germany	`eu_vat`	European VAT Number
Gibraltar	`gi_tin`	Gibraltar Tax Identification Number
Greece	`eu_vat`	European VAT Number
Guinea	`gn_nif`	Guinea Tax Identification Number (Número de Identificação Fiscal)
Hong Kong	`hk_br`	Hong Kong BR Number
Hungary	`eu_vat`	European VAT Number
Hungary	`hu_tin`	Hungary Tax Number (adószám)
Iceland	`is_vat`	Icelandic VAT
India	`in_gst`	Indian GST Number
Indonesia	`id_npwp`	Indonesian NPWP Number
Ireland	`eu_vat`	European VAT Number
Israel	`il_vat`	Israel VAT
Italy	`eu_vat`	European VAT Number
Italy	`it_cf`	Italian Codice Fiscale Number
Japan	`jp_cn`	Japanese Corporate Number (Hōjin Bangō)
Japan	`jp_rn`	Japanese Registered Foreign Businesses' Registration Number (Tōroku Kokugai Jigyōsha no Tōroku Bangō)
Japan	`jp_trn`	Japanese Tax Registration Number (Tōroku Bangō)
Kazakhstan	`kz_bin`	Kazakhstani Business Identification Number
Kenya	`ke_pin`	Kenya Revenue Authority Personal Identification Number
Kyrgyzstan	`kg_tin`	Kyrgyzstan Tax Identification Number
Laos	`la_tin`	Laos Tax Identification Number
Latvia	`eu_vat`	European VAT Number
Liechtenstein	`li_uid`	Liechtensteinian UID Number
Liechtenstein	`li_vat`	Liechtenstein VAT Number
Lithuania	`eu_vat`	European VAT Number
Luxembourg	`eu_vat`	European VAT Number
Malaysia	`my_frp`	Malaysian FRP Number
Malaysia	`my_itn`	Malaysian ITN
Malaysia	`my_sst`	Malaysian SST Number
Malta	`eu_vat`	European VAT Number
Mauritania	`mr_nif`	Mauritania Tax Identification Number (Número de Identificação Fiscal)
Mexico	`mx_rfc`	Mexican RFC Number
Moldova	`md_vat`	Moldova VAT Number
Montenegro	`me_pib`	Montenegro PIB Number
Morocco	`ma_vat`	Morocco VAT Number
Nepal	`np_pan`	Nepal PAN Number
Netherlands	`eu_vat`	European VAT Number
New Zealand	`nz_gst`	New Zealand GST Number
Nigeria	`ng_tin`	Nigerian Tax Identification Number
North Macedonia	`mk_vat`	North Macedonia VAT Number
Northern Ireland	`eu_vat`	Northern Ireland VAT Number
Norway	`no_vat`	Norwegian VAT Number
Norway	`no_voec`	Norwegian VAT on e-commerce Number
Oman	`om_vat`	Omani VAT Number
Paraguay	`py_ruc`	Paraguayan RUC Number
Peru	`pe_ruc`	Peruvian RUC Number
Philippines	`ph_tin`	Philippines Tax Identification Number
Poland	`eu_vat`	European VAT Number
Poland	`pl_nip`	Polish Tax ID Number
Portugal	`eu_vat`	European VAT Number
Romania	`eu_vat`	European VAT Number
Romania	`ro_tin`	Romanian Tax ID Number
Russia	`ru_inn`	Russian INN
Russia	`ru_kpp`	Russian KPP
Saudi Arabia	`sa_vat`	Saudi Arabia VAT
Senegal	`sn_ninea`	Senegal NINEA Number
Serbia	`rs_pib`	Serbian PIB Number
Singapore	`sg_gst`	Singaporean GST
Singapore	`sg_uen`	Singaporean UEN
Slovakia	`eu_vat`	European VAT Number
Slovenia	`eu_vat`	European VAT Number
Slovenia	`si_tin`	Slovenia Tax Number (davčna številka)
South Africa	`za_vat`	South African VAT Number
South Korea	`kr_brn`	Korean BRN
Spain	`es_cif`	Spanish NIF Number (previously Spanish CIF Number)
Spain	`eu_vat`	European VAT Number
Sri Lanka	`lk_vat`	Sri Lanka VAT Number
Suriname	`sr_fin`	Suriname FIN Number
Sweden	`eu_vat`	European VAT Number
Switzerland	`ch_uid`	Switzerland UID Number
Switzerland	`ch_vat`	Switzerland VAT Number
Taiwan	`tw_vat`	Taiwanese VAT
Tajikistan	`tj_tin`	Tajikistan Tax Identification Number
Tanzania	`tz_vat`	Tanzania VAT Number
Thailand	`th_vat`	Thai VAT
Turkey	`tr_tin`	Turkish Tax Identification Number
Uganda	`ug_tin`	Uganda Tax Identification Number
Ukraine	`ua_vat`	Ukrainian VAT
United Arab Emirates	`ae_trn`	United Arab Emirates TRN
United Kingdom	`gb_vat`	United Kingdom VAT Number
United States	`us_ein`	United States EIN
Uruguay	`uy_ruc`	Uruguayan RUC Number
Uzbekistan	`uz_tin`	Uzbekistan TIN Number
Uzbekistan	`uz_vat`	Uzbekistan VAT Number
Venezuela	`ve_rif`	Venezuelan RIF Number
Vietnam	`vn_tin`	Vietnamese Tax ID Number
Zambia	`zm_tin`	Zambia Tax Identification Number
Zimbabwe	`zw_tin`	Zimbabwe Tax Identification Number

Show child attributes

memo

string | null

required

Free-form text which is available on the invoice PDF and the Orb invoice portal.

credit_notes

CreditNoteSummary · object[]

required

A list of credit notes associated with the invoice

Show child attributes

payment_attempts

PaymentAttempt · object[]

required

A list of payment attempts associated with the invoice

Show child attributes

discount

any | null

required

deprecated

This field is deprecated in favor of discounts. If a discounts list is provided, the first discount in the list will be returned. If the list is empty, None will be returned.

discounts

(PercentageDiscount · object | AmountDiscount · object | TrialDiscount · object | TieredPercentageDiscount · object)[]

required

PercentageDiscount
AmountDiscount
TrialDiscount
TieredPercentageDiscount

Show child attributes

minimum

Minimum · object | null

required

Show child attributes

minimum_amount

string | null

required

maximum

Maximum · object | null

required

Show child attributes

maximum_amount

string | null

required

line_items

InvoiceLineItem · object[]

required

The breakdown of prices in this invoice.

Show child attributes

subtotal

string

required

The total before any discounts and minimums are applied.

Example:

"8.00"

invoice_date

string<date-time>

required

The scheduled date of the invoice

Example:

"2022-05-01T07:00:00+00:00"

Issue invoice

Pay invoice

⌘I

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

LicenseType

License

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Mark invoice as paid

Authorizations

Path Parameters

Body

Response

Supported Tax ID Countries and Types