List credit notes

curl --request GET \
  --url https://api.withorb.com/v1/credit_notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "credit_note_number": "<string>",
      "invoice_id": "<string>",
      "memo": "<string>",
      "reason": "Duplicate",
      "type": "refund",
      "subtotal": "<string>",
      "total": "<string>",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "credit_note_pdf": "<string>",
      "minimum_amount_refunded": "<string>",
      "maximum_amount_adjustment": {
        "discount_type": "percentage",
        "percentage_discount": 123,
        "amount_applied": "<string>",
        "reason": "<string>",
        "applies_to_prices": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      },
      "line_items": [
        {
          "id": "<string>",
          "name": "<string>",
          "subtotal": "<string>",
          "amount": "<string>",
          "quantity": 123,
          "tax_amounts": [
            {
              "tax_rate_description": "<string>",
              "tax_rate_percentage": "<string>",
              "amount": "<string>"
            }
          ],
          "item_id": "<string>",
          "discounts": [],
          "start_time_inclusive": "2023-11-07T05:31:56Z",
          "end_time_exclusive": "2023-11-07T05:31:56Z"
        }
      ],
      "discounts": []
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

GET

credit_notes

List credit notes

curl --request GET \
  --url https://api.withorb.com/v1/credit_notes \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "credit_note_number": "<string>",
      "invoice_id": "<string>",
      "memo": "<string>",
      "reason": "Duplicate",
      "type": "refund",
      "subtotal": "<string>",
      "total": "<string>",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "credit_note_pdf": "<string>",
      "minimum_amount_refunded": "<string>",
      "maximum_amount_adjustment": {
        "discount_type": "percentage",
        "percentage_discount": 123,
        "amount_applied": "<string>",
        "reason": "<string>",
        "applies_to_prices": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      },
      "line_items": [
        {
          "id": "<string>",
          "name": "<string>",
          "subtotal": "<string>",
          "amount": "<string>",
          "quantity": 123,
          "tax_amounts": [
            {
              "tax_rate_description": "<string>",
              "tax_rate_percentage": "<string>",
              "amount": "<string>"
            }
          ],
          "item_id": "<string>",
          "discounts": [],
          "start_time_inclusive": "2023-11-07T05:31:56Z",
          "end_time_exclusive": "2023-11-07T05:31:56Z"
        }
      ],
      "discounts": []
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

limit

integer

default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100

cursor

string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

created_at[gte]

string<date-time> | null

created_at[gt]

string<date-time> | null

created_at[lt]

string<date-time> | null

created_at[lte]

string<date-time> | null

Response

data

CreditNote · object[]

required

Show child attributes

data.id

string

required

The Orb id of this credit note.

data.created_at

string<date-time>

required

The creation time of the resource in Orb.

data.voided_at

string<date-time> | null

required

The time at which the credit note was voided in Orb, if applicable.

data.credit_note_number

string

required

The unique identifier for credit notes.

data.invoice_id

string

required

The id of the invoice resource that this credit note is applied to.

data.memo

string | null

required

An optional memo supplied on the credit note.

data.reason

enum<string> | null

required

Available options:

Duplicate,

Fraudulent,

Order change,

Product unsatisfactory

data.type

enum<string>

required

Available options:

refund,

adjustment

data.subtotal

string

required

The total prior to any creditable invoice-level discounts or minimums.

data.total

string

required

The total including creditable invoice-level discounts or minimums, and tax.

data.customer

CustomerMinified · object

required

Show child attributes

data.customer.id

string

required

data.customer.external_customer_id

string | null

required

data.credit_note_pdf

string | null

required

A URL to a PDF of the credit note.

data.minimum_amount_refunded

string | null

required

Any credited amount from the applied minimum on the invoice.

data.maximum_amount_adjustment

CreditNoteDiscount · object

required

The maximum amount applied on the original invoice

Show child attributes

data.maximum_amount_adjustment.discount_type

enum<string>

required

Available options:

percentage

data.maximum_amount_adjustment.percentage_discount

number

required

data.maximum_amount_adjustment.amount_applied

string

required

data.maximum_amount_adjustment.reason

string | null

data.maximum_amount_adjustment.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

data.maximum_amount_adjustment.applies_to_prices.id

string

required

data.maximum_amount_adjustment.applies_to_prices.name

string

required

data.line_items

CreditNoteLineItem · object[]

required

All of the line items associated with this credit note.

Show child attributes

data.line_items.id

string

required

The Orb id of this resource.

data.line_items.name

string

required

The name of the corresponding invoice line item.

data.line_items.subtotal

string

required

The amount of the line item, excluding any line item minimums and discounts.

data.line_items.amount

string

required

The amount of the line item, including any line item minimums and discounts.

data.line_items.quantity

number | null

required

An optional quantity credited.

data.line_items.tax_amounts

TaxAmount · object[]

required

Any tax amounts applied onto the line item.

Show child attributes

data.line_items.tax_amounts.tax_rate_description

string

required

The human-readable description of the applied tax rate.

data.line_items.tax_amounts.tax_rate_percentage

string | null

required

The tax rate percentage, out of 100.

data.line_items.tax_amounts.amount

string

required

The amount of additional tax incurred by this tax rate.

data.line_items.item_id

string

required

The id of the item associated with this line item.

data.line_items.discounts

CreditNoteLineItemDiscount · object[]

Any line item discounts from the invoice's line item.

Show child attributes

data.line_items.discounts.id

string

required

data.line_items.discounts.discount_type

enum<string>

required

Available options:

percentage,

amount

data.line_items.discounts.percentage_discount

number

required

data.line_items.discounts.amount_applied

string

required

data.line_items.discounts.applies_to_price_ids

string[]

required

data.line_items.discounts.amount_discount

string | null

data.line_items.discounts.reason

string | null

data.line_items.start_time_inclusive

string<date-time> | null

The start time of the service period for this credit note line item.

data.line_items.end_time_exclusive

string<date-time> | null

The end time of the service period for this credit note line item.

data.discounts

CreditNoteDiscount · object[]

Any discounts applied on the original invoice.

Show child attributes

data.discounts.discount_type

enum<string>

required

Available options:

percentage

data.discounts.percentage_discount

number

required

data.discounts.amount_applied

string

required

data.discounts.reason

string | null

data.discounts.applies_to_prices

CreditNoteDiscountAppliesToPrice · object[] | null

Show child attributes

data.discounts.applies_to_prices.id

string

required

data.discounts.applies_to_prices.name

string

required

pagination_metadata

PaginationMetadata · object

required

Show child attributes

pagination_metadata.has_more

boolean

required

pagination_metadata.next_cursor

string | null

required

Deactivate top-up Create credit note

⌘I

API documentation

Alert

Coupon

Credit

Credit note

Customer

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

List credit notes

Authorizations

Query Parameters

Response