Class: Orb::Resources::Customers::Credits::Ledger

Inherits:
Object
  • Object
show all
Defined in:
lib/orb/resources/customers/credits/ledger.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Ledger

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Ledger.

Parameters:



591
592
593
 
# File 'lib/orb/resources/customers/credits/ledger.rb', line 591

def initialize(client:)
  @client = client
end

Instance Method Details

#create_entry(customer_id, amount: , entry_type: , target_expiry_date: , block_id: , currency: nil, description: nil, effective_date: nil, expiry_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) ⇒ Orb::Models::Customers::Credits::IncrementLedgerEntry, ...

Some parameter documentations has been truncated, see Models::Customers::Credits::LedgerCreateEntryParams for more details.

This endpoint allows you to create a new ledger entry for a specified customer’s balance. This can be used to increment balance, deduct credits, and change the expiry date of existing credits.

## Effects of adding a ledger entry

  1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that represents the changes (i.e. balance changes or transfers).

  2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the [View Credits Ledger](fetch-customer-credits-ledger) response as well as serialized in the response to this request. In the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans credit blocks.

  3. If ‘invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on `amount` and `per_unit_cost_basis`).

## Adding credits

Adding credits is done by creating an entry of type ‘increment`. This requires the caller to specify a number of credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.

The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.

“‘json 

"entry_type": "increment",
"amount": 100,
"expiry_date": "2022-12-28",
"per_unit_cost_basis": "0.20",
"description": "Purchased 100 credits"

“‘

Note that by default, Orb will always first increment any negative balance in existing blocks before adding the remaining amount to the desired credit block.

### Invoicing for credits

By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass ‘invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the credits pre-purchase. Note that you must provide the `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying the cost basis with the number of credit units added.

## Deducting Credits

Orb allows you to deduct credits from a customer by creating an entry of type ‘decrement`. Orb matches the algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also optionally allows specifying a description to assist with auditing.

The following snippet illustrates a sample request body to decrement credits.

“‘json 

"entry_type": "decrement",
"amount": 20,
"description": "Removing excess credits"

“‘

## Changing credits expiry

If you’d like to change when existing credits expire, you should create a ledger entry of type ‘expiration_change`. For this entry, the required parameter `expiry_date` identifies the originating block, and the required parameter `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.

Note that the balance of the block with the given ‘expiry_date` must be at least equal to the desired transfer amount determined by the `amount` parameter.

The following snippet illustrates a sample request body to extend the expiration date of credits by one year:

“‘json 

"entry_type": "expiration_change",
"amount": 10,
"expiry_date": "2022-12-28",
"block_id": "UiUhFWeLHPrBY4Ad",
"target_expiry_date": "2023-12-28",
"description": "Extending credit validity"

“‘

## Voiding credits

If you’d like to void a credit block, create a ledger entry of type ‘void`. For this entry, `block_id` is required to identify the block, and `amount` indicates how many credits to void, up to the block’s initial balance. Pass in a ‘void_reason` of `refund` if the void is due to a refund.

## Amendment

If you’d like to undo a decrement on a credit block, create a ledger entry of type ‘amendment`. For this entry, `block_id` is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return to the customer, up to the block’s initial balance.

Parameters:

  • customer_id (String)
  • amount (Float) —

    The number of credits to effect. Note that this is required for increment, decre

  • entry_type (Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType)
  • target_expiry_date (Date) —

    A future date (specified in YYYY-MM-DD format) used for expiration change, denot

  • block_id (String) —

    The ID of the block to reverse a decrement from.

  • currency (String, nil) —

    The currency or custom pricing unit to use for this ledger entry. If this is a r

  • description (String, nil) —

    Optional metadata that can be specified when adding ledger results via the API.

  • effective_date (Time, nil) —

    An ISO 8601 format date that denotes when this credit balance should become avai

  • expiry_date (Time, nil) —

    An ISO 8601 format date that identifies the origination credit block to expire

  • invoice_settings (Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil) —

    Passing ‘invoice_settings` automatically generates an invoice for the newly adde

  • metadata (Hash{Symbol=>String, nil}, nil) —

    User-specified key/value pairs for the resource. Individual keys can be removed

  • per_unit_cost_basis (String, nil) —

    Can only be specified when entry_type=increment. How much, in the customer’s cur

  • void_reason (Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil) —

    Can only be specified when ‘entry_type=void`. The reason for the void.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/orb/resources/customers/credits/ledger.rb', line 286

def create_entry(customer_id, params)
  parsed, options = Orb::Customers::Credits::LedgerCreateEntryParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["customers/%1$s/credits/ledger_entry", customer_id],
    body: parsed,
    model: Orb::Models::Customers::Credits::LedgerCreateEntryResponse,
    options: options
  )
end

#create_entry_by_external_id(external_customer_id, amount: , entry_type: , target_expiry_date: , block_id: , currency: nil, description: nil, effective_date: nil, expiry_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {}) ⇒ Orb::Models::Customers::Credits::IncrementLedgerEntry, ...

Some parameter documentations has been truncated, see Models::Customers::Credits::LedgerCreateEntryByExternalIDParams for more details.

This endpoint allows you to create a new ledger entry for a specified customer’s balance. This can be used to increment balance, deduct credits, and change the expiry date of existing credits.

## Effects of adding a ledger entry

  1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that represents the changes (i.e. balance changes or transfers).

  2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the [View Credits Ledger](fetch-customer-credits-ledger) response as well as serialized in the response to this request. In the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans credit blocks.

  3. If ‘invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on `amount` and `per_unit_cost_basis`).

## Adding credits

Adding credits is done by creating an entry of type ‘increment`. This requires the caller to specify a number of credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.

The following snippet illustrates a sample request body to increment credits which will expire in January of 2022.

“‘json 

"entry_type": "increment",
"amount": 100,
"expiry_date": "2022-12-28",
"per_unit_cost_basis": "0.20",
"description": "Purchased 100 credits"

“‘

Note that by default, Orb will always first increment any negative balance in existing blocks before adding the remaining amount to the desired credit block.

### Invoicing for credits

By default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass ‘invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the credits pre-purchase. Note that you must provide the `per_unit_cost_basis`, since the total charges on the invoice are calculated by multiplying the cost basis with the number of credit units added.

## Deducting Credits

Orb allows you to deduct credits from a customer by creating an entry of type ‘decrement`. Orb matches the algorithm for automatic deductions for determining which credit blocks to decrement from. In the case that the deduction leads to multiple ledger entries, the response from this endpoint will be the final deduction. Orb also optionally allows specifying a description to assist with auditing.

The following snippet illustrates a sample request body to decrement credits.

“‘json 

"entry_type": "decrement",
"amount": 20,
"description": "Removing excess credits"

“‘

## Changing credits expiry

If you’d like to change when existing credits expire, you should create a ledger entry of type ‘expiration_change`. For this entry, the required parameter `expiry_date` identifies the originating block, and the required parameter `target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created with expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.

Note that the balance of the block with the given ‘expiry_date` must be at least equal to the desired transfer amount determined by the `amount` parameter.

The following snippet illustrates a sample request body to extend the expiration date of credits by one year:

“‘json 

"entry_type": "expiration_change",
"amount": 10,
"expiry_date": "2022-12-28",
"block_id": "UiUhFWeLHPrBY4Ad",
"target_expiry_date": "2023-12-28",
"description": "Extending credit validity"

“‘

## Voiding credits

If you’d like to void a credit block, create a ledger entry of type ‘void`. For this entry, `block_id` is required to identify the block, and `amount` indicates how many credits to void, up to the block’s initial balance. Pass in a ‘void_reason` of `refund` if the void is due to a refund.

## Amendment

If you’d like to undo a decrement on a credit block, create a ledger entry of type ‘amendment`. For this entry, `block_id` is required to identify the block that was originally decremented from, and `amount` indicates how many credits to return to the customer, up to the block’s initial balance.

Parameters:

  • external_customer_id (String)
  • amount (Float) —

    The number of credits to effect. Note that this is required for increment, decre

  • entry_type (Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType)
  • target_expiry_date (Date) —

    A future date (specified in YYYY-MM-DD format) used for expiration change, denot

  • block_id (String) —

    The ID of the block to reverse a decrement from.

  • currency (String, nil) —

    The currency or custom pricing unit to use for this ledger entry. If this is a r

  • description (String, nil) —

    Optional metadata that can be specified when adding ledger results via the API.

  • effective_date (Time, nil) —

    An ISO 8601 format date that denotes when this credit balance should become avai

  • expiry_date (Time, nil) —

    An ISO 8601 format date that identifies the origination credit block to expire

  • invoice_settings (Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil) —

    Passing ‘invoice_settings` automatically generates an invoice for the newly adde

  • metadata (Hash{Symbol=>String, nil}, nil) —

    User-specified key/value pairs for the resource. Individual keys can be removed

  • per_unit_cost_basis (String, nil) —

    Can only be specified when entry_type=increment. How much, in the customer’s cur

  • void_reason (Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil) —

    Can only be specified when ‘entry_type=void`. The reason for the void.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



445
446
447
448
449
450
451
452
453
454
 
# File 'lib/orb/resources/customers/credits/ledger.rb', line 445

def create_entry_by_external_id(external_customer_id, params)
  parsed, options = Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["customers/external_customer_id/%1$s/credits/ledger_entry", external_customer_id],
    body: parsed,
    model: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse,
    options: options
  )
end

#list(customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) ⇒ Orb::Internal::Page<Orb::Models::Customers::Credits::IncrementLedgerEntry, Orb::Models::Customers::Credits::DecrementLedgerEntry, Orb::Models::Customers::Credits::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::VoidLedgerEntry, Orb::Models::Customers::Credits::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::AmendmentLedgerEntry>

Some parameter documentations has been truncated, see Models::Customers::Credits::LedgerListParams for more details.

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](/api-reference/pagination) lists these entries, starting from the most recent ledger entry.

More details on using Orb’s real-time credit feature are [here](/product-catalog/prepurchase).

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](create-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](create-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](create-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.

Parameters:

Returns:

See Also:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/orb/resources/customers/credits/ledger.rb', line 122

def list(customer_id, params = {})
  parsed, options = Orb::Customers::Credits::LedgerListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["customers/%1$s/credits/ledger", customer_id],
    query: parsed.transform_keys(
      created_at_gt: "created_at[gt]",
      created_at_gte: "created_at[gte]",
      created_at_lt: "created_at[lt]",
      created_at_lte: "created_at[lte]"
    ),
    page: Orb::Internal::Page,
    model: Orb::Models::Customers::Credits::LedgerListResponse,
    options: options
  )
end

#list_by_external_id(external_customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {}) ⇒ Orb::Internal::Page<Orb::Models::Customers::Credits::IncrementLedgerEntry, Orb::Models::Customers::Credits::DecrementLedgerEntry, Orb::Models::Customers::Credits::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::VoidLedgerEntry, Orb::Models::Customers::Credits::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::AmendmentLedgerEntry>

Some parameter documentations has been truncated, see Models::Customers::Credits::LedgerListByExternalIDParams for more details.

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](/api-reference/pagination) lists these entries, starting from the most recent ledger entry.

More details on using Orb’s real-time credit feature are [here](/product-catalog/prepurchase).

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](create-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](create-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](create-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.

Parameters:

Returns:

See Also:



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/orb/resources/customers/credits/ledger.rb', line 571

def list_by_external_id(external_customer_id, params = {})
  parsed, options = Orb::Customers::Credits::LedgerListByExternalIDParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["customers/external_customer_id/%1$s/credits/ledger", external_customer_id],
    query: parsed.transform_keys(
      created_at_gt: "created_at[gt]",
      created_at_gte: "created_at[gte]",
      created_at_lt: "created_at[lt]",
      created_at_lte: "created_at[lte]"
    ),
    page: Orb::Internal::Page,
    model: Orb::Models::Customers::Credits::LedgerListByExternalIDResponse,
    options: options
  )
end