Credit

Fetch customer credits ledger by external ID

The credits ledger provides auditing functionality over Orb’s credits system with a list of actions that have taken place to modify a customer’s credit balance. This paginated endpoint lists these entries, starting from the most recent ledger entry.

More details on using Orb’s real-time credit feature are here.

There are four major types of modifications to credit balance, detailed below.

Increment

Credits (which optionally expire on a future date) can be added via the API (Add Ledger Entry). The ledger entry for such an action will always contain the total eligible starting and ending balance for the customer at the time the entry was added to the ledger.

Decrement

Deductions can occur as a result of an API call to create a ledger entry (see Add Ledger Entry), or automatically as a result of incurring usage. Both ledger entries present the decrement entry type.

As usage for a customer is reported into Orb, credits may be deducted according to the customer’s plan configuration. An automated deduction of this type will result in a ledger entry, also with a starting and ending balance. In order to provide better tracing capabilities for automatic deductions, Orb always associates each automatic deduction with the event_id at the time of ingestion, used to pinpoint why credit deduction took place and to ensure that credits are never deducted without an associated usage event.

By default, Orb uses an algorithm that automatically deducts from the soonest expiring credit block first in order to ensure that all credits are utilized appropriately. As an example, if trial credits with an expiration date of 2 weeks from now are present for a customer, they will be used before any deductions take place from a non-expiring credit block.

If there are multiple blocks with the same expiration date, Orb will deduct from the block with the lower cost basis first (e.g. trial credits with a $0 cost basis before paid credits with a$ 5.00 cost basis).

It’s also possible for a single usage event’s deduction to span credit blocks. In this case, Orb will deduct from the next block, ending at the credit block which consists of unexpiring credits. Each of these deductions will lead to a separate ledger entry, one per credit block that is deducted from. By default, the customer’s total credit balance in Orb can be negative as a result of a decrement.

Expiration change

The expiry of credits can be changed as a result of the API (See Add Ledger Entry). This will create a ledger entry that specifies the balance as well as the initial and target expiry dates.

Note that for this entry type, starting_balance will equal ending_balance, and the amount represents the balance transferred. The credit block linked to the ledger entry is the source credit block from which there was an expiration change

Credits expiry

When a set of credits expire on pre-set expiration date, the customer’s balance automatically reflects this change and adds an entry to the ledger indicating this event. Note that credit expiry should always happen close to a date boundary in the customer’s timezone.

Void initiated

Credit blocks can be voided via the API. The amount on this entry corresponds to the number of credits that were remaining in the block at time of void. void_reason will be populated if the void is created with a reason.

Void

When a set of credits is voided, the customer’s balance automatically reflects this change and adds an entry to the ledger indicating this event.

Amendment

When credits are added to a customer’s balance as a result of a correction, this entry will be added to the ledger to indicate the adjustment of credits.

GET

customers

external_customer_id

{external_customer_id}

credits

ledger

curl --request GET \
  --url https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}/credits/ledger \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "metadata": {},
      "id": "<string>",
      "ledger_sequence_number": 123,
      "entry_status": "committed",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "starting_balance": 123,
      "ending_balance": 123,
      "amount": 123,
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "credit_block": {
        "id": "<string>",
        "expiry_date": "2023-11-07T05:31:56Z",
        "per_unit_cost_basis": "<string>"
      },
      "entry_type": "increment",
      "created_invoices": [
        {
          "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": "8.00",
          "created_at": "2022-05-01T07:01:31+00:00",
          "currency": "USD",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "discount": "<any>",
          "discounts": [
            {
              "discount_type": "percentage",
              "applies_to_price_ids": [
                "h74gfhdjvn7ujokd",
                "7hfgtgjnbvc3ujkl"
              ],
              "reason": "<string>",
              "percentage_discount": 0.15
            }
          ],
          "due_date": "2022-05-30T07:00:00+00:00",
          "id": "<string>",
          "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
          "invoice_number": "JYEFHK-00001",
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              {
                "field": "price_id",
                "operator": "includes",
                "values": [
                  "<string>"
                ]
              }
            ],
            "applies_to_price_ids": [
              "<string>"
            ]
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              {
                "field": "price_id",
                "operator": "includes",
                "values": [
                  "<string>"
                ]
              }
            ],
            "applies_to_price_ids": [
              "<string>"
            ]
          },
          "maximum_amount": "<string>",
          "line_items": [
            {
              "amount": "7.00",
              "discount": {
                "discount_type": "percentage",
                "applies_to_price_ids": [
                  "h74gfhdjvn7ujokd",
                  "7hfgtgjnbvc3ujkl"
                ],
                "reason": "<string>",
                "percentage_discount": 0.15
              },
              "end_date": "2022-02-01T08:00:00+00:00",
              "grouping": "<string>",
              "minimum": {
                "minimum_amount": "<string>",
                "filters": [
                  {
                    "field": "price_id",
                    "operator": "includes",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<string>",
                "filters": [
                  {
                    "field": "price_id",
                    "operator": "includes",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "maximum_amount": "<string>",
              "adjustments": [
                {
                  "id": "<string>",
                  "is_invoice_level": true,
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ],
                  "reason": "<string>",
                  "adjustment_type": "usage_discount",
                  "usage_discount": 123,
                  "amount": "<string>"
                }
              ],
              "name": "Fixed Fee",
              "quantity": 1,
              "start_date": "2022-02-01T08:00:00+00:00",
              "subtotal": "9.00",
              "adjusted_subtotal": "5.00",
              "credits_applied": "6.00",
              "partially_invoiced_amount": "4.00",
              "sub_line_items": [
                {
                  "amount": "9.00",
                  "name": "Tier One",
                  "quantity": 5,
                  "grouping": {
                    "key": "region",
                    "value": "west"
                  },
                  "type": "matrix",
                  "matrix_config": {
                    "dimension_values": [
                      "<string>"
                    ]
                  }
                }
              ],
              "tax_amounts": [
                {
                  "tax_rate_description": "<string>",
                  "tax_rate_percentage": "<string>",
                  "amount": "<string>"
                }
              ],
              "id": "<string>",
              "price": {
                "metadata": {},
                "id": "<string>",
                "name": "<string>",
                "external_price_id": "<string>",
                "price_type": "usage_price",
                "model_type": "unit",
                "created_at": "2023-11-07T05:31:56Z",
                "cadence": "one_time",
                "billing_cycle_configuration": {
                  "duration": 123,
                  "duration_unit": "day"
                },
                "invoicing_cycle_configuration": {
                  "duration": 123,
                  "duration_unit": "day"
                },
                "billable_metric": {
                  "id": "<string>"
                },
                "dimensional_price_configuration": {
                  "dimensional_price_group_id": "<string>",
                  "dimension_values": [
                    "<string>"
                  ]
                },
                "fixed_price_quantity": 123,
                "plan_phase_order": 123,
                "currency": "<string>",
                "conversion_rate": 123,
                "item": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "credit_allocation": {
                  "currency": "<string>",
                  "allows_rollover": true,
                  "custom_expiration": {
                    "duration": 123,
                    "duration_unit": "day"
                  }
                },
                "discount": {
                  "discount_type": "percentage",
                  "applies_to_price_ids": [
                    "h74gfhdjvn7ujokd",
                    "7hfgtgjnbvc3ujkl"
                  ],
                  "reason": "<string>",
                  "percentage_discount": 0.15
                },
                "minimum": {
                  "minimum_amount": "<string>",
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ]
                },
                "minimum_amount": "<string>",
                "maximum": {
                  "maximum_amount": "<string>",
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ]
                },
                "maximum_amount": "<string>",
                "unit_config": {
                  "unit_amount": "<string>"
                }
              },
              "usage_customer_ids": [
                "<string>"
              ],
              "filter": "<string>"
            }
          ],
          "subscription": {
            "id": "VDGsT23osdLb84KD"
          },
          "subtotal": "8.00",
          "total": "8.00",
          "customer_balance_transactions": [
            {
              "id": "cgZa3SXcsPTVyC4Y",
              "created_at": "2022-05-01T07:01:31+00:00",
              "starting_balance": "33.00",
              "ending_balance": "22.00",
              "amount": "11.00",
              "action": "applied_to_invoice",
              "description": "An optional description",
              "invoice": {
                "id": "gXcsPTVyC4YZa3Sc"
              },
              "type": "increment",
              "credit_note": {
                "id": "<string>"
              }
            }
          ],
          "status": "issued",
          "invoice_source": "subscription",
          "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": {
            "country": "AD",
            "type": "ad_nrt",
            "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": "stripe",
              "payment_provider_id": "<string>",
              "amount": "<string>",
              "succeeded": true,
              "created_at": "2023-11-07T05:31:56Z"
            }
          ],
          "invoice_date": "2022-05-01T07:00:00+00:00"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

external_customer_id

string | null

required

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.

currency

string | null

The ledger currency or custom pricing unit to use.

minimum_amount

string | null

entry_type

enum<string> | null

Available options:

increment,

decrement,

expiration_change,

credit_block_expiry,

void,

void_initiated,

amendment

entry_status

enum<string> | null

Available options:

committed,

pending

created_at[gte]

string | null

created_at[gt]

string | null

created_at[lt]

string | null

created_at[lte]

string | null

Response

200

application/json

The response is of type object.

Fetch customer credit balance by external customer id Create ledger entry by external ID

curl --request GET \
  --url https://api.withorb.com/v1/customers/external_customer_id/{external_customer_id}/credits/ledger \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "metadata": {},
      "id": "<string>",
      "ledger_sequence_number": 123,
      "entry_status": "committed",
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "starting_balance": 123,
      "ending_balance": 123,
      "amount": 123,
      "currency": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "credit_block": {
        "id": "<string>",
        "expiry_date": "2023-11-07T05:31:56Z",
        "per_unit_cost_basis": "<string>"
      },
      "entry_type": "increment",
      "created_invoices": [
        {
          "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": "8.00",
          "created_at": "2022-05-01T07:01:31+00:00",
          "currency": "USD",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "discount": "<any>",
          "discounts": [
            {
              "discount_type": "percentage",
              "applies_to_price_ids": [
                "h74gfhdjvn7ujokd",
                "7hfgtgjnbvc3ujkl"
              ],
              "reason": "<string>",
              "percentage_discount": 0.15
            }
          ],
          "due_date": "2022-05-30T07:00:00+00:00",
          "id": "<string>",
          "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
          "invoice_number": "JYEFHK-00001",
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              {
                "field": "price_id",
                "operator": "includes",
                "values": [
                  "<string>"
                ]
              }
            ],
            "applies_to_price_ids": [
              "<string>"
            ]
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              {
                "field": "price_id",
                "operator": "includes",
                "values": [
                  "<string>"
                ]
              }
            ],
            "applies_to_price_ids": [
              "<string>"
            ]
          },
          "maximum_amount": "<string>",
          "line_items": [
            {
              "amount": "7.00",
              "discount": {
                "discount_type": "percentage",
                "applies_to_price_ids": [
                  "h74gfhdjvn7ujokd",
                  "7hfgtgjnbvc3ujkl"
                ],
                "reason": "<string>",
                "percentage_discount": 0.15
              },
              "end_date": "2022-02-01T08:00:00+00:00",
              "grouping": "<string>",
              "minimum": {
                "minimum_amount": "<string>",
                "filters": [
                  {
                    "field": "price_id",
                    "operator": "includes",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<string>",
                "filters": [
                  {
                    "field": "price_id",
                    "operator": "includes",
                    "values": [
                      "<string>"
                    ]
                  }
                ],
                "applies_to_price_ids": [
                  "<string>"
                ]
              },
              "maximum_amount": "<string>",
              "adjustments": [
                {
                  "id": "<string>",
                  "is_invoice_level": true,
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ],
                  "reason": "<string>",
                  "adjustment_type": "usage_discount",
                  "usage_discount": 123,
                  "amount": "<string>"
                }
              ],
              "name": "Fixed Fee",
              "quantity": 1,
              "start_date": "2022-02-01T08:00:00+00:00",
              "subtotal": "9.00",
              "adjusted_subtotal": "5.00",
              "credits_applied": "6.00",
              "partially_invoiced_amount": "4.00",
              "sub_line_items": [
                {
                  "amount": "9.00",
                  "name": "Tier One",
                  "quantity": 5,
                  "grouping": {
                    "key": "region",
                    "value": "west"
                  },
                  "type": "matrix",
                  "matrix_config": {
                    "dimension_values": [
                      "<string>"
                    ]
                  }
                }
              ],
              "tax_amounts": [
                {
                  "tax_rate_description": "<string>",
                  "tax_rate_percentage": "<string>",
                  "amount": "<string>"
                }
              ],
              "id": "<string>",
              "price": {
                "metadata": {},
                "id": "<string>",
                "name": "<string>",
                "external_price_id": "<string>",
                "price_type": "usage_price",
                "model_type": "unit",
                "created_at": "2023-11-07T05:31:56Z",
                "cadence": "one_time",
                "billing_cycle_configuration": {
                  "duration": 123,
                  "duration_unit": "day"
                },
                "invoicing_cycle_configuration": {
                  "duration": 123,
                  "duration_unit": "day"
                },
                "billable_metric": {
                  "id": "<string>"
                },
                "dimensional_price_configuration": {
                  "dimensional_price_group_id": "<string>",
                  "dimension_values": [
                    "<string>"
                  ]
                },
                "fixed_price_quantity": 123,
                "plan_phase_order": 123,
                "currency": "<string>",
                "conversion_rate": 123,
                "item": {
                  "id": "<string>",
                  "name": "<string>"
                },
                "credit_allocation": {
                  "currency": "<string>",
                  "allows_rollover": true,
                  "custom_expiration": {
                    "duration": 123,
                    "duration_unit": "day"
                  }
                },
                "discount": {
                  "discount_type": "percentage",
                  "applies_to_price_ids": [
                    "h74gfhdjvn7ujokd",
                    "7hfgtgjnbvc3ujkl"
                  ],
                  "reason": "<string>",
                  "percentage_discount": 0.15
                },
                "minimum": {
                  "minimum_amount": "<string>",
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ]
                },
                "minimum_amount": "<string>",
                "maximum": {
                  "maximum_amount": "<string>",
                  "filters": [
                    {
                      "field": "price_id",
                      "operator": "includes",
                      "values": [
                        "<string>"
                      ]
                    }
                  ],
                  "applies_to_price_ids": [
                    "<string>"
                  ]
                },
                "maximum_amount": "<string>",
                "unit_config": {
                  "unit_amount": "<string>"
                }
              },
              "usage_customer_ids": [
                "<string>"
              ],
              "filter": "<string>"
            }
          ],
          "subscription": {
            "id": "VDGsT23osdLb84KD"
          },
          "subtotal": "8.00",
          "total": "8.00",
          "customer_balance_transactions": [
            {
              "id": "cgZa3SXcsPTVyC4Y",
              "created_at": "2022-05-01T07:01:31+00:00",
              "starting_balance": "33.00",
              "ending_balance": "22.00",
              "amount": "11.00",
              "action": "applied_to_invoice",
              "description": "An optional description",
              "invoice": {
                "id": "gXcsPTVyC4YZa3Sc"
              },
              "type": "increment",
              "credit_note": {
                "id": "<string>"
              }
            }
          ],
          "status": "issued",
          "invoice_source": "subscription",
          "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": {
            "country": "AD",
            "type": "ad_nrt",
            "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": "stripe",
              "payment_provider_id": "<string>",
              "amount": "<string>",
              "succeeded": true,
              "created_at": "2023-11-07T05:31:56Z"
            }
          ],
          "invoice_date": "2022-05-01T07:00:00+00:00"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

API documentation

Alert

Coupon

Credit note

Customer

Credit

Dimensional Price Group

Event

Invoice

Item

Metric

Availability

Plan

Price

Subscription Change

Subscription

Price interval

Fetch customer credits ledger by external ID

Increment

Decrement

Expiration change

Credits expiry

Void initiated

Void

Amendment

Authorizations

Path Parameters

Query Parameters

Response