Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Rate Card Custom Pricing Unit Overage Rate object v2

Billing
Rate Card Custom Pricing Unit Overage Rates
The Rate Card Custom Pricing Unit Overage Rate object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.billing.rate_card_custom_pricing_unit_overage_rate"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • createdtimestamp

    Timestamp of when the object was created.

  • custom_pricing_unitstring

    The ID of the custom pricing unit this overage rate applies to.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • metadatanullable map

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • one_time_itemobject

    The one-time item that will be used for overage line items.

    • one_time_item.idstring

      Unique identifier for the object.

    • one_time_item.objectstring, value is "v2.billing.one_time_item"

      String representing the object’s type. Objects of the same type share the same value of the object field.

    • one_time_item.createdtimestamp

      Timestamp of when the object was created.

    • one_time_item.display_namestring

      Description that customers will see in the invoice line item. Maximum length of 250 characters.

    • one_time_item.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • one_time_item.lookup_keynullable string

      An internal key you can use to search for a particular one-time item. Maximum length of 200 characters.

    • one_time_item.metadatanullable map

      Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

    • one_time_item.unit_labelnullable string

      The unit to use when displaying prices for this one-time item. For example, set this field to “credit” for the display to show “(price) per credit”. Maximum length of 100 characters.

  • rate_cardstring

    The ID of the Rate Card this overage rate belongs to.

  • rate_card_versionstring

    The ID of the Rate Card Version this overage rate was created on.

  • unit_amountstring

    The per-unit amount to charge for overages, represented as a decimal string in minor currency units with at most 12 decimal places.

The Rate Card Custom Pricing Unit Overage Rate object
{
  "created": "2025-01-01T00:00:00.000Z",
  "custom_pricing_unit": "cpu_61T4sQA90ELFdWUhl16Ss95I3tSQSib3S1PC0IDCSFCS",
  "id": "cpuor_test_61Rc0EwMrmxaJaSum16RM8VQESSQ4t1K5KYFAmKUSPLs",
  "metadata": {},
  "object": "v2.billing.rate_card.custom_pricing_unit_overage_rate",
  "one_time_item": {
    "created": "2025-01-01T00:00:00.000Z",
    "display_name": "Setup Fee",
    "id": "bli_test_61SGRtYMvrf176Kmm16RM8VQESSQ4t1K5KYFAmKUSOTI",
    "lookup_key": "setup-fee",
    "metadata": {
      "category": "onboarding"
    },
    "object": "v2.billing.one_time_item",
    "unit_label": "per account",
    "livemode": true
  },
  "rate_card": "rcd_test_61Rc0EnUkb3UIaPVQ16RM8VQESSQ4t1K5KYFAmKUSUCG",
  "rate_card_version": "rcdv_test_61Rc0EnbIs6eHyCWW16RM8VQESSQ4t1K5KYFAmKUS2Nk",
  "unit_amount": "0.05",
  "livemode": true
}