Skip to content

Latest commit

 

History

History
executable file
·
34 lines (21 loc) · 950 Bytes

README.md

File metadata and controls

executable file
·
34 lines (21 loc) · 950 Bytes

credit_note

Overview

The Credit Note resource represents a credit note that has been generated for a customer. Credit Notes are generated when a customer's billing interval has elapsed, and are updated when a customer's invoice is paid.

Available Operations

  • list - List credit notes

list

This endpoint returns a list of all Credit Notes for an account in a list format.

The list of credit notes is ordered starting from the most recently created date. The response also includes pagination_metadata, which lets the caller retrieve the next page of results if they exist.

Example Usage

import orb
from orb.models import operations

s = orb.Orb(
    security=shared.Security(
        api_key_auth="",
    ),
)


res = s.credit_note.list('enim', 'odit', 'quo')

if res.credit_notes is not None:
    # handle response