Skip to main content
GET
/
credit_blocks
/
{block_id}
/
invoices
List invoices for credit block
curl --request GET \
  --url https://api.withorb.com/v1/credit_blocks/{block_id}/invoices \
  --header 'Authorization: Bearer <token>'
{
  "block": {
    "id": "<string>",
    "balance": 123,
    "effective_date": "2023-11-07T05:31:56Z",
    "expiry_date": "2023-11-07T05:31:56Z",
    "per_unit_cost_basis": "<string>",
    "status": "active",
    "maximum_initial_balance": 123,
    "filters": [
      {
        "field": "price_id",
        "operator": "includes",
        "values": [
          "<string>"
        ]
      }
    ]
  },
  "invoices": [
    {
      "id": "<string>",
      "invoice_number": "<string>",
      "status": "issued",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "subscription": {
        "id": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

block_id
string
required

Response

OK

block
CreditBlock · object
required

The Credit Block resource models prepaid credits within Orb.

invoices
InvoiceMinified · object[]
required