--- title: "Fetch customer credits ledger" method: GET path: "/customers/{customer_id}/credits/ledger" tags: ["Credit"] --- # Fetch customer credits ledger `GET /customers/{customer_id}/credits/ledger` 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. Each day's usage for a particular price, invoice, and block will be grouped into a single entry. 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. ## Path parameters - `customer_id` string, nullable, required ## Query parameters - `limit` integer — The number of items to fetch. Defaults to 20. - `cursor` string, nullable — Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request. - `currency` string, nullable — The ledger currency or custom pricing unit to use. - `minimum_amount` string, nullable - `entry_type` 'increment' | 'decrement' | 'expiration_change' | 'credit_block_expiry' | 'void' | 'void_initiated' | 'amendment', nullable - `entry_status` 'committed' | 'pending', nullable - `created_at[gte]` string, date-time, nullable - `created_at[gt]` string, date-time, nullable - `created_at[lt]` string, date-time, nullable - `created_at[lte]` string, date-time, nullable ## Response `200` OK - CreditLedgerEntries - `data` CreditLedgerEntry[], required - union — The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb. - IncrementLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'increment', required - `created_invoices` Invoice[], nullable — If the increment resulted in invoice creation, the list of created invoices - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `voided_at` string, date-time, nullable, required — If the invoice has a status of `void`, this gives a timestamp when the invoice was voided. - `paid_at` string, date-time, nullable, required — If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid. - `issued_at` string, date-time, nullable, required — If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.) - `scheduled_issue_at` string, date-time, nullable, required — If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued. - `auto_collection` AutoCollection, required - `next_attempt_at` string, date-time, nullable, required — If the invoice is scheduled for auto-collection, this field will reflect when the next attempt will occur. If dunning has been exhausted, or auto-collection is not enabled for this invoice, this field will be `null`. - `previously_attempted_at` string, date-time, nullable, required — If Orb has ever attempted payment auto-collection for this invoice, this field will reflect when that attempt occurred. In conjunction with `next_attempt_at`, this can be used to tell whether the invoice is currently in dunning (that is, `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or if dunning has been exhausted (`previously_attempted_at` is non-null, but `next_attempt_time` is null). - `enabled` boolean, nullable, required — True only if auto-collection is enabled for this invoice. - `num_attempts` integer, nullable, required — Number of auto-collection payment attempts. - `issue_failed_at` string, date-time, nullable, required — If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.) - `sync_failed_at` string, date-time, nullable, required — If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing. - `payment_failed_at` string, date-time, nullable, required — If payment was attempted on this invoice but failed, this will be the time of the most recent attempt. - `payment_started_at` string, date-time, nullable, required — If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more. - `amount_due` string, required — This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice. - `created_at` string, date-time, required — The creation time of the resource in Orb. - `currency` string, required — An ISO 4217 currency string or `credits` - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `due_date` string, date-time, nullable, required — When the invoice payment is due. The due date is null if the invoice is not yet finalized. - `id` string, required - `invoice_pdf` string, nullable, required — The link to download the PDF representation of the `Invoice`. - `invoice_number` string, required — Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer. - `subscription` SubscriptionMinified, required - `id` string, required - `total` string, required — The total after any minimums and discounts have been applied. - `customer_balance_transactions` CustomerBalanceTransaction[], required - `id` string, required — A unique id for this transaction. - `created_at` string, date-time, required — The creation time of this transaction. - `starting_balance` string, required — The original value of the customer's balance prior to the transaction, in the customer's currency. - `ending_balance` string, required — The new value of the customer's balance prior to the transaction, in the customer's currency. - `amount` string, required — The value of the amount changed in the transaction. - `action` 'applied_to_invoice' | 'manual_adjustment' | 'prorated_refund' | 'revert_prorated_refund' | 'return_from_voiding' | 'credit_note_applied' | 'credit_note_voided' | 'overpayment_refund' | 'external_payment' | 'small_invoice_carryover', required - `description` string, nullable, required — An optional description provided for manual customer balance adjustments. - `invoice` InvoiceTiny, required - … - `type` 'increment' | 'decrement', required - `credit_note` CreditNoteTiny, required - … - `status` 'issued' | 'paid' | 'synced' | 'void' | 'draft', required - `invoice_source` 'subscription' | 'partial' | 'one_off', required - `shipping_address` Address, required - `line1` string, nullable, required - `line2` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `billing_address` Address, required - `line1` string, nullable, required - `line2` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `hosted_invoice_url` string, nullable, required — A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date — whichever is later. - `will_auto_issue` boolean, required — This is true if the invoice will be automatically issued in the future, and false otherwise. - `eligible_to_issue_at` string, date-time, nullable, required — If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time. - `customer_tax_id` CustomerTaxId, required — Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices. ### Supported Tax ID Countries and Types | Country | Type | Description | |---------|------|-------------| | Albania | `al_tin` | Albania Tax Identification Number | | Andorra | `ad_nrt` | Andorran NRT Number | | Angola | `ao_tin` | Angola Tax Identification Number | | Argentina | `ar_cuit` | Argentinian Tax ID Number | | Armenia | `am_tin` | Armenia Tax Identification Number | | Aruba | `aw_tin` | Aruba Tax Identification Number | | Australia | `au_abn` | Australian Business Number (AU ABN) | | Australia | `au_arn` | Australian Taxation Office Reference Number | | Austria | `eu_vat` | European VAT Number | | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number | | Bahamas | `bs_tin` | Bahamas Tax Identification Number | | Bahrain | `bh_vat` | Bahraini VAT Number | | Bangladesh | `bd_bin` | Bangladesh Business Identification Number | | Barbados | `bb_tin` | Barbados Tax Identification Number | | Belarus | `by_tin` | Belarus TIN Number | | Belgium | `eu_vat` | European VAT Number | | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) | | Bolivia | `bo_tin` | Bolivian Tax ID | | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number | | Brazil | `br_cnpj` | Brazilian CNPJ Number | | Brazil | `br_cpf` | Brazilian CPF Number | | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code | | Bulgaria | `eu_vat` | European VAT Number | | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) | | Cambodia | `kh_tin` | Cambodia Tax Identification Number | | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) | | Canada | `ca_bn` | Canadian BN | | Canada | `ca_gst_hst` | Canadian GST/HST Number | | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) | | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) | | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) | | Canada | `ca_qst` | Canadian QST Number (Québec) | | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) | | Chile | `cl_tin` | Chilean TIN | | China | `cn_tin` | Chinese Tax ID | | Colombia | `co_nit` | Colombian NIT Number | | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) | | Costa Rica | `cr_tin` | Costa Rican Tax ID | | Croatia | `eu_vat` | European VAT Number | | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) | | Cyprus | `eu_vat` | European VAT Number | | Czech Republic | `eu_vat` | European VAT Number | | Denmark | `eu_vat` | European VAT Number | | Dominican Republic | `do_rcn` | Dominican RCN Number | | Ecuador | `ec_ruc` | Ecuadorian RUC Number | | Egypt | `eg_tin` | Egyptian Tax Identification Number | | El Salvador | `sv_nit` | El Salvadorian NIT Number | | Estonia | `eu_vat` | European VAT Number | | Ethiopia | `et_tin` | Ethiopia Tax Identification Number | | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme | | Faroe Islands | `fo_vat` | Faroe Islands VAT Number | | Finland | `eu_vat` | European VAT Number | | France | `eu_vat` | European VAT Number | | Georgia | `ge_vat` | Georgian VAT | | Germany | `de_stn` | German Tax Number (Steuernummer) | | Germany | `eu_vat` | European VAT Number | | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number | | Greece | `eu_vat` | European VAT Number | | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) | | Hong Kong | `hk_br` | Hong Kong BR Number | | Hungary | `eu_vat` | European VAT Number | | Hungary | `hu_tin` | Hungary Tax Number (adószám) | | Iceland | `is_vat` | Icelandic VAT | | India | `in_gst` | Indian GST Number | | Indonesia | `id_npwp` | Indonesian NPWP Number | | Ireland | `eu_vat` | European VAT Number | | Israel | `il_vat` | Israel VAT | | Italy | `eu_vat` | European VAT Number | | Italy | `it_cf` | Italian Codice Fiscale Number | | Japan | `jp_cn` | Japanese Corporate Number (*Hōjin Bangō*) | | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (*Tōroku Kokugai Jigyōsha no Tōroku Bangō*) | | Japan | `jp_trn` | Japanese Tax Registration Number (*Tōroku Bangō*) | | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number | | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number | | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number | | Laos | `la_tin` | Laos Tax Identification Number | | Latvia | `eu_vat` | European VAT Number | | Liechtenstein | `li_uid` | Liechtensteinian UID Number | | Liechtenstein | `li_vat` | Liechtenstein VAT Number | | Lithuania | `eu_vat` | European VAT Number | | Luxembourg | `eu_vat` | European VAT Number | | Malaysia | `my_frp` | Malaysian FRP Number | | Malaysia | `my_itn` | Malaysian ITN | | Malaysia | `my_sst` | Malaysian SST Number | | Malta | `eu_vat` | European VAT Number | | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) | | Mexico | `mx_rfc` | Mexican RFC Number | | Moldova | `md_vat` | Moldova VAT Number | | Montenegro | `me_pib` | Montenegro PIB Number | | Morocco | `ma_vat` | Morocco VAT Number | | Nepal | `np_pan` | Nepal PAN Number | | Netherlands | `eu_vat` | European VAT Number | | New Zealand | `nz_gst` | New Zealand GST Number | | Nigeria | `ng_tin` | Nigerian Tax Identification Number | | North Macedonia | `mk_vat` | North Macedonia VAT Number | | Northern Ireland | `eu_vat` | Northern Ireland VAT Number | | Norway | `no_vat` | Norwegian VAT Number | | Norway | `no_voec` | Norwegian VAT on e-commerce Number | | Oman | `om_vat` | Omani VAT Number | | Paraguay | `py_ruc` | Paraguayan RUC Number | | Peru | `pe_ruc` | Peruvian RUC Number | | Philippines | `ph_tin` | Philippines Tax Identification Number | | Poland | `eu_vat` | European VAT Number | | Poland | `pl_nip` | Polish Tax ID Number | | Portugal | `eu_vat` | European VAT Number | | Romania | `eu_vat` | European VAT Number | | Romania | `ro_tin` | Romanian Tax ID Number | | Russia | `ru_inn` | Russian INN | | Russia | `ru_kpp` | Russian KPP | | Saudi Arabia | `sa_vat` | Saudi Arabia VAT | | Senegal | `sn_ninea` | Senegal NINEA Number | | Serbia | `rs_pib` | Serbian PIB Number | | Singapore | `sg_gst` | Singaporean GST | | Singapore | `sg_uen` | Singaporean UEN | | Slovakia | `eu_vat` | European VAT Number | | Slovenia | `eu_vat` | European VAT Number | | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) | | South Africa | `za_vat` | South African VAT Number | | South Korea | `kr_brn` | Korean BRN | | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) | | Spain | `eu_vat` | European VAT Number | | Sri Lanka | `lk_vat` | Sri Lanka VAT Number | | Suriname | `sr_fin` | Suriname FIN Number | | Sweden | `eu_vat` | European VAT Number | | Switzerland | `ch_uid` | Switzerland UID Number | | Switzerland | `ch_vat` | Switzerland VAT Number | | Taiwan | `tw_vat` | Taiwanese VAT | | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number | | Tanzania | `tz_vat` | Tanzania VAT Number | | Thailand | `th_vat` | Thai VAT | | Turkey | `tr_tin` | Turkish Tax Identification Number | | Uganda | `ug_tin` | Uganda Tax Identification Number | | Ukraine | `ua_vat` | Ukrainian VAT | | United Arab Emirates | `ae_trn` | United Arab Emirates TRN | | United Kingdom | `gb_vat` | United Kingdom VAT Number | | United States | `us_ein` | United States EIN | | Uruguay | `uy_ruc` | Uruguayan RUC Number | | Uzbekistan | `uz_tin` | Uzbekistan TIN Number | | Uzbekistan | `uz_vat` | Uzbekistan VAT Number | | Venezuela | `ve_rif` | Venezuelan RIF Number | | Vietnam | `vn_tin` | Vietnamese Tax ID Number | | Zambia | `zm_tin` | Zambia Tax Identification Number | | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number | - `country` 'AD' | 'AE' | 'AL' | 'AM' | 'AO' | 'AR' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BJ' | 'BO' | 'BR' | 'BS' | 'BY' | 'CA' | 'CD' | 'CH' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CY' | 'CZ' | 'DE' | 'DK' | 'DO' | 'EC' | 'EE' | 'EG' | 'ES' | 'ET' | 'EU' | 'FI' | 'FO' | 'FR' | 'GB' | 'GE' | 'GI' | 'GN' | 'GR' | 'HK' | 'HR' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IS' | 'IT' | 'JP' | 'KE' | 'KG' | 'KH' | 'KR' | 'KZ' | 'LA' | 'LI' | 'LK' | 'LT' | 'LU' | 'LV' | 'MA' | 'MD' | 'ME' | 'MK' | 'MR' | 'MT' | 'MX' | 'MY' | 'NG' | 'NL' | 'NO' | 'NP' | 'NZ' | 'OM' | 'PE' | 'PH' | 'PL' | 'PT' | 'PY' | 'RO' | 'RS' | 'RU' | 'SA' | 'SE' | 'SG' | 'SI' | 'SK' | 'SN' | 'SR' | 'SV' | 'TH' | 'TJ' | 'TR' | 'TW' | 'TZ' | 'UA' | 'UG' | 'US' | 'UY' | 'UZ' | 'VE' | 'VN' | 'ZA' | 'ZM' | 'ZW', required - `type` 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'eu_vat' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'fo_vat' | 'gb_vat' | 'ge_vat' | 'gi_tin' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'it_cf' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'py_ruc' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin', required - `value` string, required - `memo` string, nullable, required — Free-form text which is available on the invoice PDF and the Orb invoice portal. - `credit_notes` CreditNoteSummary[], required — A list of credit notes associated with the invoice - `id` string, required - `credit_note_number` string, required - `reason` string, required - `total` string, required - `voided_at` string, date-time, nullable, required — If the credit note has a status of `void`, this gives a timestamp when the credit note was voided. - `type` string, required - `memo` string, nullable, required — An optional memo supplied on the credit note. - `payment_attempts` PaymentAttempt[], required — A list of payment attempts associated with the invoice - `id` string, required — The ID of the payment attempt. - `payment_provider` 'stripe' | 'adyen', nullable, required — The payment provider that attempted to collect the payment. - `payment_provider_id` string, nullable, required — The ID of the payment attempt in the payment provider. - `amount` string, required — The amount of the payment attempt. - `succeeded` boolean, required — Whether the payment attempt succeeded. - `created_at` string, date-time, required — The time at which the payment attempt was created. - `receipt_pdf` string, nullable, required — URL to the downloadable PDF version of the receipt. This field will be `null` for payment attempts that did not succeed. - `discount` unknown, required - `discounts` InvoiceLevelDiscount[], required - union - … - `minimum` Minimum, required - `minimum_amount` string, required — Minimum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this minimum to. - … - `applies_to_price_ids` string[], required — List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices. - `minimum_amount` string, nullable, required - `maximum` Maximum, required - `maximum_amount` string, required — Maximum amount applied - `filters` PriceFilter[], required — The filters that determine which prices to apply this maximum to. - … - `applies_to_price_ids` string[], required — List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices. - `maximum_amount` string, nullable, required - `line_items` InvoiceLineItem[], required — The breakdown of prices in this invoice. - `amount` string, required — The final amount for a line item after all adjustments and pre paid credits have been applied. - `end_date` string, date-time, required — The end date of the range of time applied for this line item's price. - `grouping` string, nullable, required — [DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The `amount` and `subtotal` will be the values for this particular grouping. - `adjustments` MonetaryAdjustment[], required — All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums). - … - `name` string, required — The name of the price associated with this line item. - `quantity` number, required — Either the fixed fee quantity or the usage during the service period. - `start_date` string, date-time, required — The start date of the range of time applied for this line item's price. - `subtotal` string, required — The line amount before any adjustments. - `adjusted_subtotal` string, required — The line amount after any adjustments and before overage conversion, credits and partial invoicing. - `credits_applied` string, required — The number of prepaid credits applied. - `partially_invoiced_amount` string, required — Any amount applied from a partial invoice - `sub_line_items` InvoiceSubLineItem[], required — For complex pricing structures, the line item can be broken down further in `sub_line_items`. - … - `tax_amounts` TaxAmount[], required — An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured. - … - `id` string, required — A unique ID for this line item. - `price` union, required — The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in the form of an invoice line item. Prices take a quantity and determine an amount to bill. Orb supports a few different pricing models out of the box. Each of these models is serialized differently in a given Price object. The model_type field determines the key for the configuration object that is present. For more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price) - … - `usage_customer_ids` string[], nullable, required — A list of customer ids that were used to calculate the usage for this line item. - `filter` string, nullable, required — An additional filter that was used to calculate the usage for this line item. - `subtotal` string, required — The total before any discounts and minimums are applied. - `invoice_date` string, date-time, required — The scheduled date of the invoice - DecrementLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'decrement', required - `price_id` string, nullable - `invoice_id` string, nullable - `event_id` string, nullable — This field is deprecated and will always be null. Decrements are not associated with individual events. - ExpirationChangeLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'expiration_change', required - `new_block_expiry_date` string, date-time, nullable, required - CreditBlockExpiryLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'credit_block_expiry', required - VoidLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'void', required - `void_reason` string, nullable, required - `void_amount` number, required - VoidInitiatedLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'void_initiated', required - `new_block_expiry_date` string, date-time, required - `void_reason` string, nullable, required - `void_amount` number, required - AmendmentLedgerEntry - `metadata` object, required — User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`. - `id` string, required - `ledger_sequence_number` integer, required - `entry_status` 'committed' | 'pending', required - `customer` CustomerMinified, required - `id` string, required - `external_customer_id` string, nullable, required - `starting_balance` number, required - `ending_balance` number, required - `amount` number, required - `currency` string, required - `created_at` string, date-time, required - `description` string, nullable, required - `credit_block` AffectedBlock, required - `id` string, required - `expiry_date` string, date-time, nullable, required - `per_unit_cost_basis` string, nullable, required - `filters` PriceFilter[], required - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on. - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded. - `values` string[], required — The IDs or values that match this filter. - `entry_type` 'amendment', required - `pagination_metadata` PaginationMetadata, required - `has_more` boolean, required - `next_cursor` string, nullable, required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found - `409` — Conflict - `413` — Content Too Large - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.dev/withorb/apis/api-reference.md) · [All operations](https://skmtc.dev/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withorb/api-reference/revisions/816dfe734e2e/schema)